Technical Writing for Developers

This skill provides best practices and templates for writing clear, maintainable internal documentation.

Core Principles

1. Audience Awareness: Write for your teammates (and your future self). Assume they know how to code, but not why this specific code exists.
2. Active Voice: Use active voice for instructions.
   • Bad: "The server should be started by running..."
   • Good: "Run npm start to start the server."
3. Single Source of Truth: Don't duplicate code logic in comments. Explain why, not what.
4. Front-Load Context: Put the most important information (what is this? how do I run it?) at the top.

Common Artifacts & Templates

1. README.md (Root or Component)

Every significant directory should have a README.