DEV Community

# documentation

Improving and writing documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
Building Centralized Documentation Across Microservices with Docusaurus, GitLab CI, and TypeDoc

Building Centralized Documentation Across Microservices with Docusaurus, GitLab CI, and TypeDoc

Comments
5 min read
Software Development Documentation and Workflow

Software Development Documentation and Workflow

Comments
2 min read
API Documentation Is Part of the Product — A Technical Perspective

API Documentation Is Part of the Product — A Technical Perspective

1
Comments
1 min read
🎮 Day 3 – Understanding GDD (Game Design Document)

🎮 Day 3 – Understanding GDD (Game Design Document)

Comments
1 min read
From Code to Content: How Codedraft automates Technical Writing

From Code to Content: How Codedraft automates Technical Writing

3
Comments 1
5 min read
What is Technical Writing For B2B SaaS Companies?

What is Technical Writing For B2B SaaS Companies?

Comments
4 min read
Documentation is a Feature: Why I’m Obsessing Over "Time-to-Hello-World"

Documentation is a Feature: Why I’m Obsessing Over "Time-to-Hello-World"

Comments
1 min read
Fixing a Broken Example Link

Fixing a Broken Example Link

Comments
1 min read
Correcting a Mismatch Between Code and Text

Correcting a Mismatch Between Code and Text

Comments
1 min read
Adding a Simple Summary at the Top of a Complex Page

Adding a Simple Summary at the Top of a Complex Page

Comments
1 min read
Correcting a Wrong File Name in a Tutorial

Correcting a Wrong File Name in a Tutorial

Comments
1 min read
Updating Screenshots to Match the Current UI

Updating Screenshots to Match the Current UI

Comments
1 min read
Fixing a Broken Example Link

Fixing a Broken Example Link

Comments
1 min read
Adding a Simple Summary at the Top of a Complex Page

Adding a Simple Summary at the Top of a Complex Page

Comments
1 min read
Improving a Section That Caused Repeated Questions

Improving a Section That Caused Repeated Questions

Comments
1 min read
Correcting a Misleading Description of a Feature

Correcting a Misleading Description of a Feature

Comments
1 min read
Adding a Missing Step to the Devnet Walkthrough

Adding a Missing Step to the Devnet Walkthrough

Comments
1 min read
Making Testnet vs Devnet Usage Clearer

Making Testnet vs Devnet Usage Clearer

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

How does API work? WHere's the manual?

Comments
3 min read
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
Export Your Confluence Documentation Like a Pro: Introducing Confluence Export CLI

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

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

SpecMD — What if Your Documentation Was Your Code?

Comments
2 min read
loading...