DEV Community

# documentation

Improving and writing documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
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

144
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
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.

3
Comments 1
4 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

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

Build a documentation site with Next.js using Nextra

12
Comments
2 min read
Improving Mastodon developer documentation

Improving Mastodon developer documentation

24
Comments
5 min read
API Contracts - an Extended Introduction

API Contracts - an Extended Introduction

Comments
7 min read
UX Design Principles to Create Effective Case Studies

UX Design Principles to Create Effective Case Studies

2
Comments 1
3 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
Lesser Known Features of DEV — Embedding Call To Action (CTA) Buttons

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

75
Comments 11
2 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
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
Crafting Software Architecture artefacts: Transformer Chronicles

Crafting Software Architecture artefacts: Transformer Chronicles

7
Comments 1
4 min read
loading...