Documentation Writer

To create a project README, the Skill generates a comprehensive document containing project overviews, installation guides, and usage instructions. It requires read, write, edit, grep, and glob file system tools to interact with your codebase and produce structured documentation.

An architectural decision record (ADR) captures system designs and structural choices to ensure codebases remain maintainable. You need to write ADRs when making significant architectural decisions that future developers must understand and follow.

Yes, you can write API documentation for an existing codebase by generating JSDoc and TSDoc for functions, classes, and types. The Skill uses grep and glob tools to scan your files and edit tools to insert the generated documentation directly.

The best way to create a README file is to use a documentation generation Skill that analyzes your project structure and outputs project overviews, installation guides, and usage instructions. This ensures clear, maintainable documentation without manual formatting overhead.

Automating technical writing tasks requires read, write, edit, grep, and glob file system tools. These tools allow the Skill to scan directories, locate code modules, and generate or modify documentation files directly within your project structure.