Forem

# documentation

Improving and writing documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
A GitBook-Style Docs Site with Next.js (App Router), Markdown, SEO, and Cloudflare Workers
Cover image for A GitBook-Style Docs Site with Next.js (App Router), Markdown, SEO, and Cloudflare Workers

A GitBook-Style Docs Site with Next.js (App Router), Markdown, SEO, and Cloudflare Workers

Comments
7 min read
Writing API Documentation That Developers Actually Read

Writing API Documentation That Developers Actually Read

1
Comments
5 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.
Cover image for 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
Cover image for 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
Cover image for 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)
Cover image for 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
Cover image for 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
A Small Workflow Hack for Converting Markdown to Clean HTML (Without Adding a New Tool to the Stack)

A Small Workflow Hack for Converting Markdown to Clean HTML (Without Adding a New Tool to the Stack)

3
Comments
2 min read
AI Coding Agents Aren't Production-Ready. Here's What's Actually Breaking.
Cover image for 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.
Cover image for 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
How do you keep engineering context alive when requirements change? Post:

How do you keep engineering context alive when requirements change? Post:

1
Comments
1 min read
Five Patterns for Building Self-Updating Documentation
Cover image for Five Patterns for Building Self-Updating Documentation

Five Patterns for Building Self-Updating Documentation

1
Comments
6 min read
Mother CLAUDE: How We Built a Documentation System That Makes LLMs Productive Immediately
Cover image for Mother CLAUDE: How We Built a Documentation System That Makes LLMs Productive Immediately

Mother CLAUDE: How We Built a Documentation System That Makes LLMs Productive Immediately

7
Comments 1
8 min read
I Got Tired of Outdated DB Diagrams, So I Built a Tool That Understands Schemas Instead

I Got Tired of Outdated DB Diagrams, So I Built a Tool That Understands Schemas Instead

1
Comments
2 min read
Making Retype Docs AI-Ready with llms.txt Automation
Cover image for Making Retype Docs AI-Ready with llms.txt Automation

Making Retype Docs AI-Ready with llms.txt Automation

Comments
2 min read
Anyone else feel like they spend more time finding information than writing code?

Anyone else feel like they spend more time finding information than writing code?

Comments
1 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
Do you use Architecture Decision Records?* I’m a big fan, and I think they’re a best practice every engineering org should adopt

Do you use Architecture Decision Records?* I’m a big fan, and I think they’re a best practice every engineering org should adopt

Comments
1 min read
The Block Structure of Podlite
Cover image for 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
Cover image for Enterprise Help Center Governance: Roles, SLAs, and Content Owners

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

Comments
3 min read
loading...