tech-impl-doc_skill

Overview

This skill produces precise technical implementation documents for developer or user audiences, with clear structure, accurate execution flows, render-safe Mermaid diagrams, and audience-appropriate detail. It avoids boilerplate, emphasizes concrete steps and trade-offs, and adds a meaningful Code Index for developer docs.

How this skill works

I confirm audience, scope, output location, language, and diagram preferences up front. I draft the core request-to-execution flow, add render-safe Mermaid diagrams for multi-step processes, and then add constraints, failure modes, and a Code Index when the audience is developers. The result is a compact, actionable doc with links or code references tailored to the chosen audience.

When to use it

• You need a developer implementation guide with code paths, line numbers, and a Code Index.
• You need an operator or user guide describing configuration, behavior, and operational steps.
• You need a focused architecture or design write-up that calls out trade-offs and failure modes.
• You want a render-safe sequence or interaction diagram using Mermaid for flows.
• You want a consolidated doc that synthesizes multiple existing sources without duplication.

Best practices

• Confirm audience and exact scope before drafting (features, subsystems, or endpoints).
• Prefer numbered sections for complex flows and minimize introductory filler.
• Use render-safe Mermaid labels (simple IDs and quoted labels if they include special chars).
• For developer docs include file paths, line numbers, and a Code Index explaining responsibility.
• Call out constraints, unsupported features, and likely failure modes explicitly.

Example use cases

• Developer-facing doc that maps HTTP request → handler → service → DB and includes a Code Index with file and function roles.
• Operator guide that lists required config, startup steps, health checks, and recovery procedures with raw links.
• Design decision record that compares two approaches, lists trade-offs, and includes a flowchart of the chosen path.
• Migration plan describing stepwise cutover, verification checks, and rollback steps with a Mermaid sequence diagram.
• Component deep dive that documents performance constraints, failure scenarios, and mitigation tactics.