DEV Community

# documentation

Posts

đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.
Markdown, Asciidoc, or reStructuredText - a tale of docs-as-code

Markdown, Asciidoc, or reStructuredText - a tale of docs-as-code

3
Comments
20 min read
How to Lint Code and Prose in Documentation

How to Lint Code and Prose in Documentation

1
Comments
5 min read
Enhance your Docsify experience with your own plugin

Enhance your Docsify experience with your own plugin

2
Comments
5 min read
Lesser Known Features of DEV — Using Comment Templates

Lesser Known Features of DEV — Using Comment Templates

26
Comments 8
2 min read
How to deploy a sphinx styled documentation

How to deploy a sphinx styled documentation

2
Comments
3 min read
Documentation 101: creating a good README for your software project

Documentation 101: creating a good README for your software project

77
Comments 7
5 min read
Documentação técnica para iniciantes, parte 1: criando um bom README para o seu projeto

Documentação técnica para iniciantes, parte 1: criando um bom README para o seu projeto

73
Comments 3
7 min read
Connecting to EC2 Instances using Azure AD Users

Connecting to EC2 Instances using Azure AD Users

4
Comments
3 min read
Changelog con Notion

Changelog con Notion

4
Comments
4 min read
Writing better README.md files using GitHub flavoured markdown

Writing better README.md files using GitHub flavoured markdown

9
Comments
2 min read
DocAsCode con Notion

DocAsCode con Notion

4
Comments
5 min read
HacktoberFest Review

HacktoberFest Review

4
Comments 1
3 min read
Bing Webmaster Tools De-indexed My Docs Site and Increased My Cognitive Load

Bing Webmaster Tools De-indexed My Docs Site and Increased My Cognitive Load

7
Comments 3
3 min read
Pitching Raku

Pitching Raku

3
Comments 5
1 min read
Hacktoberfest Update 4/4 completed

Hacktoberfest Update 4/4 completed

4
Comments
1 min read
How to write a good README

How to write a good README

103
Comments 10
11 min read
Using AWS CDK to Deploy EventCatalog

Using AWS CDK to Deploy EventCatalog

9
Comments
7 min read
Documenting React components using docz

Documenting React components using docz

3
Comments
7 min read
Possibly The Ultimate Technical Documentation Guide, maybe.

Possibly The Ultimate Technical Documentation Guide, maybe.

Comments
2 min read
Documentation in Agile

Documentation in Agile

1
Comments
4 min read
GraphQL API design: lessons from building a dashboard

GraphQL API design: lessons from building a dashboard

2
Comments
9 min read
New RDoc Markup Reference

New RDoc Markup Reference

5
Comments
1 min read
Using SQLite to generate documentation and software configurations

Using SQLite to generate documentation and software configurations

4
Comments
6 min read
How to Document Code with Swimm.io

How to Document Code with Swimm.io

7
Comments
5 min read
Read The F****** Manual!

Read The F****** Manual!

14
Comments 7
3 min read
Results of Quick Testing of Documentation Tools' Accessibility

Results of Quick Testing of Documentation Tools' Accessibility

22
Comments 2
8 min read
Production-Ready Feature Documentation Checklist

Production-Ready Feature Documentation Checklist

4
Comments
3 min read
Event driven API documentation made simple (Client-Side Rendering).

Event driven API documentation made simple (Client-Side Rendering).

1
Comments
5 min read
This Week In React #114: Docusaurus 2.0, Meta's static site generator to build beautiful docs sites

This Week In React #114: Docusaurus 2.0, Meta's static site generator to build beautiful docs sites

7
Comments
5 min read
Tips & Tricks for Writing a Workaround

Tips & Tricks for Writing a Workaround

Comments
5 min read
Going Wild with Hugo Modules

Going Wild with Hugo Modules

9
Comments
6 min read
Feedback widget in Docusaurus

Feedback widget in Docusaurus

5
Comments
2 min read
Document first

Document first

20
Comments
2 min read
Badges - TL;DR for your repository's README

Badges - TL;DR for your repository's README

26
Comments 1
8 min read
My Two Cents on Technical Documentation

My Two Cents on Technical Documentation

8
Comments
3 min read
Today i found out : colorful markdown code blocks

Today i found out : colorful markdown code blocks

7
Comments
1 min read
Achieving a Docs Vision

Achieving a Docs Vision

7
Comments
5 min read
Better dev experience starts from a proper document

Better dev experience starts from a proper document

10
Comments 1
6 min read
Document Like You Code

Document Like You Code

8
Comments
9 min read
Documentação a linha ténue entre usar ou não o clean code

Documentação a linha ténue entre usar ou não o clean code

7
Comments
4 min read
Asciidoctor - A Writer's Swiss Army Knife

Asciidoctor - A Writer's Swiss Army Knife

9
Comments
3 min read
A simple example of a Fhir client in java

A simple example of a Fhir client in java

7
Comments
6 min read
The importance of good Documentation

The importance of good Documentation

20
Comments 3
4 min read
openAPI has Swagger!

openAPI has Swagger!

7
Comments 2
4 min read
Importance of reading documentation

Importance of reading documentation

4
Comments
2 min read
Docs for Everyone!

Docs for Everyone!

24
Comments 8
15 min read
bundlejs: An online esbuild based bundler & npm package size checker

bundlejs: An online esbuild based bundler & npm package size checker

9
Comments
32 min read
May contributing.today: on technical documentation, docs tools and markup languages đź“–

May contributing.today: on technical documentation, docs tools and markup languages đź“–

8
Comments
5 min read
📜 API Documentation release automation with Github, redocly and Open API 🦾

📜 API Documentation release automation with Github, redocly and Open API 🦾

Comments 7
2 min read
Ruby Module Enumerable Is Your Hidden Friend

Ruby Module Enumerable Is Your Hidden Friend

9
Comments
1 min read
How to create SEO friendly documentation with DocZ? 📜✍️

How to create SEO friendly documentation with DocZ? 📜✍️

16
Comments
7 min read
Free TechLeads from managing documentation

Free TechLeads from managing documentation

5
Comments
3 min read
How to take awesome screenshots of Azure Portal with Edge

How to take awesome screenshots of Azure Portal with Edge

3
Comments 1
2 min read
Should documentation be in included in the definition of done?

Should documentation be in included in the definition of done?

15
Comments 2
2 min read
Introducing offline-docs, collection of scripts to generate offline documentation of open-source projects

Introducing offline-docs, collection of scripts to generate offline documentation of open-source projects

8
Comments 3
2 min read
How to read the documentation

How to read the documentation

5
Comments
4 min read
Lesser Known Features of DEV — Ignoring a Tag via Negative Follow Weights

Lesser Known Features of DEV — Ignoring a Tag via Negative Follow Weights

38
Comments 23
1 min read
A importância de uma boa Documentação

A importância de uma boa Documentação

300
Comments 17
8 min read
Why should you use Tech Proposals

Why should you use Tech Proposals

5
Comments
7 min read
Effective Software Documentation*

Effective Software Documentation*

13
Comments
4 min read
loading...