DEV Community

# documentation

Improving and writing documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
Simplifying Technical Jargon in the Docs

Simplifying Technical Jargon in the Docs

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

Correcting a Code Example

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

Bad Documentation Examples: Why Developers Drop Off | Fixes

Comments
3 min read
Engineers Don’t Hate Documentation.

Engineers Don’t Hate Documentation.

5
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
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
Writing Docs in a World Where LLMs Are the Readers

Writing Docs in a World Where LLMs Are the Readers

8
Comments
4 min read
Documentation Should Not Be a Project

Documentation Should Not Be a Project

Comments
2 min read
AI Coding Agents Aren't Production-Ready. Here's What's Actually Breaking.

AI Coding Agents Aren't Production-Ready. Here's What's Actually Breaking.

5
Comments
6 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
DocuNext — A Sleek, Minimal Documentation Platform Built with Next.js & MDX 🚀

DocuNext — A Sleek, Minimal Documentation Platform Built with Next.js & MDX 🚀

1
Comments
1 min read
The Block Structure of Podlite

The Block Structure of Podlite

Comments
2 min read
Why You Need an AI Prose Linter in Your Documentation Workflow

Why You Need an AI Prose Linter in Your Documentation Workflow

1
Comments
4 min read
Enterprise Help Center Governance: Roles, SLAs, and Content Owners

Enterprise Help Center Governance: Roles, SLAs, and Content Owners

Comments
3 min read
Technical Design Documents - Part 1 - Case-Study 1

Technical Design Documents - Part 1 - Case-Study 1

Comments
1 min read
Prose Linting for Technical Teams: What Grammarly Can’t Do

Prose Linting for Technical Teams: What Grammarly Can’t Do

Comments
5 min read
Fumadocs for Products with Rapidly Evolving SPIs & SDKs

Fumadocs for Products with Rapidly Evolving SPIs & SDKs

Comments
3 min read
Building Centralized Documentation Across Microservices with Docusaurus, GitLab CI, and TypeDoc

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

Comments 1
5 min read
loading...