DEV Community

# documentation

Improving and writing documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
Export Your Confluence Documentation Like a Pro: Introducing Confluence Export CLI

Export Your Confluence Documentation Like a Pro: Introducing Confluence Export CLI

1
4 min read
Improving a Section That Caused Repeated Questions

Improving a Section That Caused Repeated Questions

1 min read
Correcting a Misleading Description of a Feature

Correcting a Misleading Description of a Feature

1 min read
Adding a Missing Step to the Devnet Walkthrough

Adding a Missing Step to the Devnet Walkthrough

1 min read
Making Testnet vs Devnet Usage Clearer

Making Testnet vs Devnet Usage Clearer

1 min read
How does API work? WHere's the manual?

How does API work? WHere's the manual?

3 min read
Documentation Sucks (I may have made it suck less)

Documentation Sucks (I may have made it suck less)

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

Clarifying What Runs On-Chain vs Off-Chain

1 min read
Improving a Tutorial That Failed During Testing

Improving a Tutorial That Failed During Testing

1 min read
Fixing a Misleading Diagram Description

Fixing a Misleading Diagram Description

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

SpecMD — What if Your Documentation Was Your Code?

2 min read
Your Code is a Liability: Why Documentation is the Only Asset That Matters

Your Code is a Liability: Why Documentation is the Only Asset That Matters

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

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

2 min read
Adding a Missing Example for Privacy Controls

Adding a Missing Example for Privacy Controls

1 min read
Simplifying Technical Jargon in the Docs

Simplifying Technical Jargon in the Docs

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.

2 min read
Fixing Broken Links in the Developer Resources

Fixing Broken Links in the Developer Resources

1 min read
Clarifying Zero Knowledge Proof Concepts

Clarifying Zero Knowledge Proof Concepts

1 min read
Automate Content Quality with VectorLint GitHub Action

Automate Content Quality with VectorLint GitHub Action

2
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)

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
10 min read
Correcting a Code Example

Correcting a Code Example

1 min read
Bad Documentation Examples: Why Developers Drop Off | Fixes

Bad Documentation Examples: Why Developers Drop Off | Fixes

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)

1 min read
Engineers Don’t Hate Documentation.

Engineers Don’t Hate Documentation.

5
3 min read
loading...
Morty Proxy This is a proxified and sanitized view of the page, visit original site.