tech-docslisted

Design, write, update, and verify technical documentation for product and software users, operators, and contributors, including READMEs, setup and task guides, API and CLI references, migration notes, JSDoc, TSDoc, rustdoc, explanatory code comments, executable examples, and ASD-STE100 Simplified Technical English. Use when asked to create or improve technical docs, document a public interface or migration, write or review English technical text in STE or a controlled language, apply tekom-style rule-based writing or controlled technical German, align documentation with implementation, or validate docs against repository conventions. Do not use for general marketing copy; route repository-wide documentation audits and prioritization to codebase-improvement.
sebastian-software/skills.sebastian-software.com · ★ 0 · Code & Development · score 70

Install: claude install-skill sebastian-software/skills.sebastian-software.com

# Tech Docs Make documentation a trustworthy interface to the product or software. Help the intended reader complete a real task, understand the relevant contract, and recover from likely failures without inventing behavior or imposing a foreign docs system. ## Workflow 1. Discover the repository before choosing a document shape. Read scoped agent instructions, existing READMEs and docs, navigation and generator config, contribution guidance, terminology, language, implementation, tests, and repository-native validation commands relevant to the requested surface. 2. Define the documentation job: audience, task or decision, entry point, prerequisites, expected result, likely failure paths, and the interface or behavior that is the source of truth. Ask only for gaps that cannot be resolved from the repository. 3. Choose the narrowest owning surface and read its reference: - README, setup, task, conceptual, or contributor guide: read [Guides and READMEs](references/guides-and-readmes.md). - API, CLI, configuration, or migration documentation: read [Interfaces and Migrations](references/interfaces-and-migrations.md). - JSDoc, TSDoc, rustdoc, docstrings, or explanatory comments: read [Code Documentation](references/code-documentation.md). - ASD-STE100, Simplified Technical English, STE, controlled English, international maintenance text, or an STE conformance review: read [Simplified Technical English](references/simplified