tech-writer

Overview

This skill produces documentation that meets the writing standards of the target industry, formatted for the intended audience and display device. It includes readability scoring and deterministic format conversion.

Documentation Workflow

Step 1: Analyze the Project

• Scan codebase structure, existing docs, README, code comments, package.json/pyproject.toml/go.mod/Cargo.toml
• Identify what exists vs what's missing
• Note the project's primary language, framework, and domain

Step 2: Detect Document Type

Route to the appropriate workflow based on what the user is asking for:

• README fast path if: user asked for a README, output is README.md, user said "document this project" with no format/framework/industry specified, or any ambiguous single-project documentation request
• Full pipeline (Step 3+) if: user requested a specific output format (PDF, DOCX, HTML), a specific framework (Diátaxis, DITA), a specific industry, or a non-README document type (user guide, API docs, whitepaper, compliance doc, report)