Documentation
3 guides tagged “Documentation”.
- What Is OpenAPI (and Do You Need It)? OpenAPI is a machine-readable description of your API. Learn what it is, what it is not, and whether a small app should bother with a spec.
- How to Write Comments That AI Assistants Actually Read and Use AI assistants read your comments to understand intent and constraints. But they ignore noise and copy bad patterns. Here's what to write — intent over mechanics, constraints over descriptions, and contracts over implementation.
- How to Write a README That People (and AI) Can Actually Use A good README tells a stranger how to run your project in two minutes. Learn the six sections that matter and what AI agents read in yours.