DEV Community

# documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
My 3 Rules for Documenting Code

My 3 Rules for Documenting Code

124
Comments 22
6 min read
How to write a perfect README for your GitHub project

How to write a perfect README for your GitHub project

83
Comments 15
4 min read
Documentação em toda parte

Documentação em toda parte

81
Comments 5
3 min read
📢 Announcing New Local Dev Setup Options for Contributing to Forem!

📢 Announcing New Local Dev Setup Options for Contributing to Forem!

77
Comments 6
3 min read
⭐Crafting Effective Documentation

⭐Crafting Effective Documentation

76
Comments 14
5 min read
Meteor is getting new docs!

Meteor is getting new docs!

71
Comments 2
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

66
Comments 9
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
The best software engineers write instead of code

The best software engineers write instead of code

47
Comments 33
2 min read
Creating an Automated Documentation Pipeline in PHP with Autodocs and GitHub Actions

Creating an Automated Documentation Pipeline in PHP with Autodocs and GitHub Actions

42
Comments 3
9 min read
📝 🚀 Creating our first documentation from scratch using Astro and Refact AI coding assistant

📝 🚀 Creating our first documentation from scratch using Astro and Refact AI coding assistant

30
Comments 2
6 min read
Improving Mastodon developer documentation

Improving Mastodon developer documentation

24
Comments
5 min read
Librarian 4: a static site generator inspired by Hugo, influenced by DEV, built in PHP

Librarian 4: a static site generator inspired by Hugo, influenced by DEV, built in PHP

22
Comments
3 min read
Essential Documentation Categories

Essential Documentation Categories

19
Comments
3 min read
How to build a beautiful docs site with VitePress and Render

How to build a beautiful docs site with VitePress and Render

19
Comments 1
5 min read
Mastering Readme Files

Mastering Readme Files

18
Comments
4 min read
How to write USEFUL documentation

How to write USEFUL documentation

18
Comments 9
4 min read
Making a single line break in markdown

Making a single line break in markdown

18
Comments 4
1 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
Top 5 Open-Source Documentation Development Platforms of 2024

Top 5 Open-Source Documentation Development Platforms of 2024

14
Comments 1
10 min read
Document your Open Source library with a Free AI chatbot

Document your Open Source library with a Free AI chatbot

13
Comments 5
3 min read
15 Minutes of Documentation 📖 for 15 Days

15 Minutes of Documentation 📖 for 15 Days

12
Comments
4 min read
The Role of Documentation in Open Source Success

The Role of Documentation in Open Source Success

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

Converting Jupyter Notebooks to Markdown Made Easy with nbconvert

12
Comments
3 min read
Documenting Your Tech Journey: The Key to Success

Documenting Your Tech Journey: The Key to Success

11
Comments
3 min read
Alternatives to Docusaurus for product documentation

Alternatives to Docusaurus for product documentation

10
Comments 4
9 min read
Concise Gherkin - How brevity improves BDD scenarios

Concise Gherkin - How brevity improves BDD scenarios

10
Comments
3 min read
How to define Objects with type definitions in JSDoc comments

How to define Objects with type definitions in JSDoc comments

9
Comments
2 min read
How to Build and Document a Go REST API with Gin and Go-Swagger

How to Build and Document a Go REST API with Gin and Go-Swagger

8
Comments
15 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
Python Documentation With Docstrings and Sphinx

Python Documentation With Docstrings and Sphinx

8
Comments 1
12 min read
Crafting Software Architecture artefacts: Transformer Chronicles

Crafting Software Architecture artefacts: Transformer Chronicles

7
Comments
4 min read
Stop Using Markdown For Documentation

Stop Using Markdown For Documentation

7
Comments 7
9 min read
Code Graphs with Mermaid

Code Graphs with Mermaid

7
Comments 3
2 min read
Structurer votre doc pour la rendre utile

Structurer votre doc pour la rendre utile

7
Comments
7 min read
Convertendo números binários para decimais com RUST!

Convertendo números binários para decimais com RUST!

6
Comments 2
6 min read
The Future of Documentation is Personalized

The Future of Documentation is Personalized

6
Comments 2
8 min read
Regenerate Immediately and RSS

Regenerate Immediately and RSS

6
Comments
3 min read
Documentation Made Easy

Documentation Made Easy

6
Comments
3 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

6
Comments
2 min read
ER Diagram Sample for Ecommerce Project

ER Diagram Sample for Ecommerce Project

6
Comments
3 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
ERDIA: TypeORM entity specification documentation tool

ERDIA: TypeORM entity specification documentation tool

6
Comments
3 min read
Écrire une doc technique utile

Écrire une doc technique utile

5
Comments
4 min read
Duplicate Finder for Documentation

Duplicate Finder for Documentation

5
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

5
Comments 4
8 min read
API Design and Architecture

API Design and Architecture

5
Comments 2
5 min read
Revising Rakudoc

Revising Rakudoc

5
Comments
3 min read
How to improve the documentation of your Ruby on Rails app

How to improve the documentation of your Ruby on Rails app

5
Comments
3 min read
What's in Ruby class Array

What's in Ruby class Array

5
Comments
1 min read
How to Containerize Your Docusaurus (And Why You Should)

How to Containerize Your Docusaurus (And Why You Should)

5
Comments
4 min read
ChatGPT Unplugged: Empowering Developer for documentation

ChatGPT Unplugged: Empowering Developer for documentation

5
Comments
6 min read
Scaling Diagram Documentation

Scaling Diagram Documentation

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

The CSS Gradient Handbook: Mastering Techniques, Tops

4
Comments
12 min read
Reinventing Pod6: Moving Forward

Reinventing Pod6: Moving Forward

4
Comments 4
2 min read
Create up-to-date screenshots of your application

Create up-to-date screenshots of your application

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

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

4
Comments
7 min read
The Death of Comments

The Death of Comments

4
Comments 8
1 min read
Add comments to your Docusaurus website in 5 minutes

Add comments to your Docusaurus website in 5 minutes

4
Comments 15
3 min read
How to Write Accessible Technical Documentation – Best Practices with Examples

How to Write Accessible Technical Documentation – Best Practices with Examples

4
Comments
10 min read
loading...