DEV Community

# documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
✨ Mermaid Markdown: Adding Life and Creativity to your GitHub Markdown Files 👩‍💻🌈📄

✨ Mermaid Markdown: Adding Life and Creativity to your GitHub Markdown Files 👩‍💻🌈📄

1
Comments 1
3 min read
Create up-to-date screenshots of your application

Create up-to-date screenshots of your application

4
Comments
4 min read
The CSS Gradient Handbook: Mastering Techniques, Tops

The CSS Gradient Handbook: Mastering Techniques, Tops

4
Comments
12 min read
🗒️ Best Alternatives to Apple Notes 📝

🗒️ Best Alternatives to Apple Notes 📝

1
Comments 1
7 min read
Stop Using Markdown For Documentation

Stop Using Markdown For Documentation

11
Comments 7
9 min read
AWS documentation frustrations

AWS documentation frustrations

2
Comments
6 min read
Building project docs for GitHub Pages

Building project docs for GitHub Pages

2
Comments
6 min read
ERDIA: TypeORM entity specification documentation tool

ERDIA: TypeORM entity specification documentation tool

9
Comments
3 min read
Amalgam: Roadmap to 0.1.0

Amalgam: Roadmap to 0.1.0

2
Comments
1 min read
Introducing Markdown GitHub Stars Updater

Introducing Markdown GitHub Stars Updater

Comments
2 min read
Never write tests or docs again! - Amalgam could change everything.

Never write tests or docs again! - Amalgam could change everything.

17
Comments 3
4 min read
API Design and Architecture

API Design and Architecture

4
Comments 2
5 min read
Master The Art Of Code Documentation In 5 Minutes

Master The Art Of Code Documentation In 5 Minutes

8
Comments
3 min read
Documentation Made Easy

Documentation Made Easy

4
Comments
3 min read
The Death of Comments

The Death of Comments

4
Comments 8
1 min read
code block trong MSWord

code block trong MSWord

Comments
2 min read
A habilidade mais importante para um desenvolvedor é a comunicação

A habilidade mais importante para um desenvolvedor é a comunicação

Comments
7 min read
Why Developers Should Stop Using ISO 8601 for Date-Time

Why Developers Should Stop Using ISO 8601 for Date-Time

2
Comments
2 min read
Leaders must document

Leaders must document

2
Comments 1
3 min read
Perfectly sizing images in your API documentation

Perfectly sizing images in your API documentation

1
Comments
4 min read
Effective Documentation

Effective Documentation

1
Comments 1
4 min read
RakuDoc revision open to comment

RakuDoc revision open to comment

3
Comments
5 min read
Documentation is Essential in Software Engineering and we all need to write more of it.

Documentation is Essential in Software Engineering and we all need to write more of it.

2
Comments
4 min read
Code Graphs with Mermaid

Code Graphs with Mermaid

11
Comments 3
2 min read
Reinventing Pod6: Moving Forward

Reinventing Pod6: Moving Forward

4
Comments 4
2 min read
Laravel-Hands-On, a Learning resource for Laravel beginners

Laravel-Hands-On, a Learning resource for Laravel beginners

6
Comments
1 min read
MSWord Styles

MSWord Styles

2
Comments
1 min read
Bump.sh included in the GitHub Student Developer Pack

Bump.sh included in the GitHub Student Developer Pack

2
Comments
2 min read
Documentation as Code for Cloud

Documentation as Code for Cloud

Comments
3 min read
How To Prepare For When A Key Employee Gets "Hit by a Bus"

How To Prepare For When A Key Employee Gets "Hit by a Bus"

Comments
6 min read
The secret to writing code that speaks for itself

The secret to writing code that speaks for itself

Comments
4 min read
How to write a perfect README for your GitHub project

How to write a perfect README for your GitHub project

130
Comments 15
4 min read
Revising Rakudoc

Revising Rakudoc

6
Comments
3 min read
What makes library docs great [Library review: Iron]

What makes library docs great [Library review: Iron]

1
Comments
7 min read
Just in time documentation is the right documentation

Just in time documentation is the right documentation

Comments
2 min read
Rswag validation checks

Rswag validation checks

Comments
2 min read
Technical Writing with AI: Ways to Use AI Writing Assistant to Write Technical Content

Technical Writing with AI: Ways to Use AI Writing Assistant to Write Technical Content

7
Comments 4
8 min read
What's Open Web Docs?

What's Open Web Docs?

Comments
8 min read
Technical Writing 101: Technical Ultimate Guide.

Technical Writing 101: Technical Ultimate Guide.

1
Comments
3 min read
Creando diagramas con ChatGPT y Mermaid js

Creando diagramas con ChatGPT y Mermaid js

120
Comments
2 min read
Build a documentation site with Next.js using Nextra

Build a documentation site with Next.js using Nextra

7
Comments
2 min read
Improving Mastodon developer documentation

Improving Mastodon developer documentation

24
Comments
5 min read
UX Design Principles to Create Effective Case Studies

UX Design Principles to Create Effective Case Studies

1
Comments
3 min read
API Contracts - an Extended Introduction

API Contracts - an Extended Introduction

Comments
7 min read
What's in Ruby class Array

What's in Ruby class Array

5
Comments
1 min read
Architectural documentation and communication

Architectural documentation and communication

1
Comments 3
12 min read
How to Organize and Structure Technical Documentation for your Team

How to Organize and Structure Technical Documentation for your Team

4
Comments
4 min read
This week focus: Documentation

This week focus: Documentation

3
Comments
2 min read
Scaling Diagram Documentation

Scaling Diagram Documentation

4
Comments
2 min read
Lesser Known Features of DEV — Embedding Call To Action (CTA) Buttons

Lesser Known Features of DEV — Embedding Call To Action (CTA) Buttons

68
Comments 10
2 min read
A practical overview on Architecture Decision Records (ADR)

A practical overview on Architecture Decision Records (ADR)

48
Comments 4
8 min read
Mastering Readme Files

Mastering Readme Files

18
Comments
4 min read
How to use Analytics to improve your Technical documentation's performance

How to use Analytics to improve your Technical documentation's performance

Comments
3 min read
Crafting Software Architecture artefacts: Transformer Chronicles

Crafting Software Architecture artefacts: Transformer Chronicles

7
Comments 1
4 min read
Simplify Your Documentation Workflow with MkDocs: A Markdown-based Alternative to Sphinx

Simplify Your Documentation Workflow with MkDocs: A Markdown-based Alternative to Sphinx

11
Comments
2 min read
How to define Objects with type definitions in JSDoc comments

How to define Objects with type definitions in JSDoc comments

12
Comments
2 min read
Why AvioBook switched from Swagger UI to Bump.sh for all of their APIs

Why AvioBook switched from Swagger UI to Bump.sh for all of their APIs

Comments
4 min read
Converting Jupyter Notebooks to Markdown Made Easy with nbconvert

Converting Jupyter Notebooks to Markdown Made Easy with nbconvert

16
Comments 1
3 min read
ChatGPT Unplugged: Empowering Developer for documentation

ChatGPT Unplugged: Empowering Developer for documentation

5
Comments
6 min read
Async API documentation 101

Async API documentation 101

1
Comments
1 min read
loading...