Forem

# documentation

Improving and writing documentation

Posts

đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.
I built a plugin that checks if your docs are still in sync with your code
Cover image for I built a plugin that checks if your docs are still in sync with your code

I built a plugin that checks if your docs are still in sync with your code

Comments
1 min read
How to Write a Good README: Your Project's Most Important File [2026 Guide]

How to Write a Good README: Your Project's Most Important File [2026 Guide]

Comments
8 min read
Introducing Signal: documentation that lives in your code

Introducing Signal: documentation that lives in your code

Comments
13 min read
Why we built provenance into a notes app
Cover image for Why we built provenance into a notes app

Why we built provenance into a notes app

Comments
4 min read
Day 4: Output Parsers — Turning AI Chatter into Structured Data 🛠️

Day 4: Output Parsers — Turning AI Chatter into Structured Data 🛠️

Comments
2 min read
Why your Ansible repo has no documentation (and how to fix it without writing any)

Why your Ansible repo has no documentation (and how to fix it without writing any)

Comments
3 min read
Product sprints for developer-oriented portals and content
Cover image for Product sprints for developer-oriented portals and content

Product sprints for developer-oriented portals and content

Comments
5 min read
User Guide and System Manual of UniDorm Management System

User Guide and System Manual of UniDorm Management System

Comments
4 min read
The Difference Between Bad AI Docs and Useful AI Docs
Cover image for The Difference Between Bad AI Docs and Useful AI Docs

The Difference Between Bad AI Docs and Useful AI Docs

2
Comments
7 min read
A single HTML file for architecture docs
Cover image for A single HTML file for architecture docs

A single HTML file for architecture docs

Comments
3 min read
From Foley Recording to a Usable Sound Library
Cover image for From Foley Recording to a Usable Sound Library

From Foley Recording to a Usable Sound Library

Comments
5 min read
From README.md to README.mp4: Why AI-Native Repositories Need a Conceptual Entry Point
Cover image for From README.md to README.mp4: Why AI-Native Repositories Need a Conceptual Entry Point

From README.md to README.mp4: Why AI-Native Repositories Need a Conceptual Entry Point

Comments
4 min read
Your Documentation Has Two Audiences Now (And One Is an AI)

Your Documentation Has Two Audiences Now (And One Is an AI)

5
Comments
4 min read
AI Agent Swarm Fixes Documentation Site While Acting Like a Real Dev Team

AI Agent Swarm Fixes Documentation Site While Acting Like a Real Dev Team

Comments
3 min read
Claude Code skills need maintenance, not just a good first draft
Cover image for Claude Code skills need maintenance, not just a good first draft

Claude Code skills need maintenance, not just a good first draft

Comments
10 min read
đź‘‹ Sign in for the ability to sort posts by relevant, latest, or top.