[go: up one dir, main page]

DEV Community

# documentation

Improving and writing documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
Documentation Sucks (I may have made it suck less)

Documentation Sucks (I may have made it suck less)

Comments
2 min read
Clarifying What Runs On-Chain vs Off-Chain

Clarifying What Runs On-Chain vs Off-Chain

Comments
1 min read
Improving a Tutorial That Failed During Testing

Improving a Tutorial That Failed During Testing

Comments
1 min read
Fixing a Misleading Diagram Description

Fixing a Misleading Diagram Description

Comments
1 min read
SpecMD — What if Your Documentation Was Your Code?

SpecMD — What if Your Documentation Was Your Code?

Comments
2 min read
Leafwiki v0.5.2 - is out - dark mode and Markdown improvements

Leafwiki v0.5.2 - is out - dark mode and Markdown improvements

Comments
2 min read
Adding a Missing Example for Privacy Controls

Adding a Missing Example for Privacy Controls

Comments
1 min read
How to Write in Markdown but Deliver in Word. A Senior Architect's Workflow.

How to Write in Markdown but Deliver in Word. A Senior Architect's Workflow.

Comments
2 min read
Simplifying Technical Jargon in the Docs

Simplifying Technical Jargon in the Docs

Comments
1 min read
Fixing Broken Links in the Developer Resources

Fixing Broken Links in the Developer Resources

Comments
1 min read
Clarifying Zero Knowledge Proof Concepts

Clarifying Zero Knowledge Proof Concepts

Comments
1 min read
Automate Content Quality with VectorLint GitHub Action

Automate Content Quality with VectorLint GitHub Action

2
Comments 1
8 min read
How to Document AI Agents (Because Traditional Docs Won't Cut It)

How to Document AI Agents (Because Traditional Docs Won't Cut It)

Comments
4 min read
How I Built an MCP Server to Create My Own AI Writing Style Guide Expert

How I Built an MCP Server to Create My Own AI Writing Style Guide Expert

1
Comments
10 min read
Correcting a Code Example

Correcting a Code Example

Comments
1 min read
Legacy Code Got You Crying? Batch Docs Can Help

Legacy Code Got You Crying? Batch Docs Can Help

4
Comments
3 min read
Bad Documentation Examples: Why Developers Drop Off | Fixes

Bad Documentation Examples: Why Developers Drop Off | Fixes

Comments
3 min read
Why README.md always goes out of sync (and how I fixed it)

Why README.md always goes out of sync (and how I fixed it)

Comments
1 min read
Engineers Don’t Hate Documentation.

Engineers Don’t Hate Documentation.

5
Comments
3 min read
Client Project Documents Every Developer Should Care About

Client Project Documents Every Developer Should Care About

Comments
3 min read
Building and Pushing a Custom Docker Image to Docker Hub

Building and Pushing a Custom Docker Image to Docker Hub

Comments
2 min read
Help Center Structure Explained for Better Self-Service

Help Center Structure Explained for Better Self-Service

Comments
3 min read
Docfx-Plus: A template and a tool to enhance DocFx and migrate from SHFB (Sandcastle)

Docfx-Plus: A template and a tool to enhance DocFx and migrate from SHFB (Sandcastle)

Comments
2 min read
Documentation Should Not Be a Project

Documentation Should Not Be a Project

Comments
2 min read
I Prompted AI Hundreds of Times. The Documentation Fixed It in One Go.

I Prompted AI Hundreds of Times. The Documentation Fixed It in One Go.

Comments
2 min read
loading...