documentation-writer

To write a README file for a software project, this Skill generates user-facing documentation by adhering to strict user-centered, clarity-first, and scannable content principles. It structures your project requirements into a clear setup guide with consistent voice and formatting.

Generating user guides from existing code involves auditing the project base and refining the findings into structured documentation. This Skill creates new content based on code audits, ensuring your user guide meets defined style guide requirements for technical writing.

Yes, you can edit existing technical documentation for clarity using this Skill. It refines current content by applying a structured workflow across preparation, execution, and verification phases to ensure all user-facing documentation follows scannable content principles.

Yes, this approach works for creating API documentation. The Skill generates and refines API documentation alongside README files and setup guides, maintaining a consistent voice, tone, and formatting across all technical content outputs.

To ensure your technical writing follows a strict style guide, the Skill enforces style guide compliance during the generation and editing process. It maintains a defined voice and tone while applying user-centered, clarity-first principles to all documentation tasks.