DEV Community

# documentation

Posts

đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.
Code Graphs with Mermaid

Code Graphs with Mermaid

13
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

133
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

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

Build a documentation site with Next.js using Nextra

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

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

69
Comments 11
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
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

12
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
Deployment Notes: How we document changes to production

Deployment Notes: How we document changes to production

Comments
5 min read
Documentação Viva: Uma Nova Abordagem para Documentação de Software

Documentação Viva: Uma Nova Abordagem para Documentação de Software

3
Comments
6 min read
O Método de Documentação C4Model e sua aplicação com PUML

O Método de Documentação C4Model e sua aplicação com PUML

6
Comments
3 min read
Building Better Docs - Automating Jekyll Builds and Link Checking for PRs

Building Better Docs - Automating Jekyll Builds and Link Checking for PRs

Comments
4 min read
Effortlessly Create Documentation and Guides with Tango: The Ultimate Time-Saving Tool - It's Free

Effortlessly Create Documentation and Guides with Tango: The Ultimate Time-Saving Tool - It's Free

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

Add comments to your Docusaurus website in 5 minutes

8
Comments 15
3 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
Constructing a Personalized ChatGPT Assistant: Optimize Your Documentation with SEO Techniques

Constructing a Personalized ChatGPT Assistant: Optimize Your Documentation with SEO Techniques

Comments
6 min read
Moving Config Docs From YAML to Markdown

Moving Config Docs From YAML to Markdown

6
Comments
2 min read
Getting Started with Glasp on Chrome - A Comprehensive Guide

Getting Started with Glasp on Chrome - A Comprehensive Guide

6
Comments 1
13 min read
Writing Effective User Guides for Your Software Products

Writing Effective User Guides for Your Software Products

2
Comments
2 min read
Automatically Document Your Database in Markdown

Automatically Document Your Database in Markdown

29
Comments
2 min read
#DEVDiscuss: Documentation Workflows

#DEVDiscuss: Documentation Workflows

17
Comments 16
1 min read
JUnit 5: link tests with task tracker issues

JUnit 5: link tests with task tracker issues

12
Comments 3
8 min read
Using Sandpack for React Libraries Documentation

Using Sandpack for React Libraries Documentation

12
Comments
5 min read
Are your PDFs Actually Redacted? Double Check!

Are your PDFs Actually Redacted? Double Check!

1
Comments
3 min read
Supercharge Your UI Development with Storybook

Supercharge Your UI Development with Storybook

Comments
2 min read
Document or Die: The Importance of Writing Things Down in Tech

Document or Die: The Importance of Writing Things Down in Tech

63
Comments 18
4 min read
Illustrating git Branching with Markdown and Mermaid.js

Illustrating git Branching with Markdown and Mermaid.js

4
Comments
4 min read
From Data Collection to Model Deployment: Key Deliverables in a Machine Learning Project

From Data Collection to Model Deployment: Key Deliverables in a Machine Learning Project

4
Comments
2 min read
Best Practices for Code Documentation: Ensuring Clarity, Maintainability, and Collaboration in Software Development

Best Practices for Code Documentation: Ensuring Clarity, Maintainability, and Collaboration in Software Development

11
Comments 1
4 min read
🚀 Supercharge Your Code Documentation with DocuWriter.ai

🚀 Supercharge Your Code Documentation with DocuWriter.ai

1
Comments
3 min read
How To Build A Spotify Playlist Analyzer

How To Build A Spotify Playlist Analyzer

2
Comments
6 min read
loading...