{"enrichment":{"faq":[{"a":"technical-writing helps you create architectural decision records (ADRs) that document design choices and their trade-offs in a structured format. ADRs capture the context, decision, consequences, and alternatives considered, making it easy for teams to understand why architectural choices were made and what constraints they address. This prevents knowledge loss and supports onboarding.","q":"How to write architectural decision records?"},{"a":"technical-writing generates four primary documentation types: architectural decision records for design choices, system architecture documentation for onboarding and stakeholder communication, API documentation with endpoints and schemas, and operational runbooks for incident response and deployment. Each type is tailored to its audience's needs and detail level.","q":"What types of documentation does technical-writing produce?"},{"a":"technical-writing creates API documentation that includes endpoints, request/response schemas, authentication details, and usage examples. It structures this information for integration teams and external developers, ensuring consistency across your API reference and preventing documentation from drifting out of sync with actual implementations.","q":"How do I document API endpoints with technical-writing?"},{"a":"Yes, technical-writing develops operational runbooks for incident response and deployment procedures. These runbooks provide step-by-step guidance for operations teams, including detection criteria, escalation paths, and resolution steps. Templates ensure consistency across your operational documentation.","q":"Can technical-writing help create incident response runbooks?"},{"a":"technical-writing maintains version-controlled documentation aligned with your code, reducing the risk of documentation becoming outdated. By treating documentation as a living artifact tied to your codebase and enforcing review practices, it helps keep technical information current and trustworthy for all stakeholders.","q":"How does technical-writing prevent documentation drift?"},{"a":"technical-writing produces system architecture documentation that explains high-level concepts, component relationships, data flows, and key decisions for new team members. It matches detail and terminology to audience expertise, helping onboard developers quickly while providing stakeholders with the context they need.","q":"What's included in system architecture documentation for onboarding?"}],"shadow_tags":["knowledge-preservation","decision-tracking","system-design-docs","operational-procedures","api-reference","team-onboarding","incident-response","architecture-decisions","runbook-automation","documentation-governance"],"summary_rewrite":"This skill produces structured technical documentation across four types: architectural decision records for design choices, system overviews for onboarding, API references for integrations, and operational runbooks for procedures. It enforces anti-patterns like documentation drift and future fiction while matching detail to audience\u2014from high-level concepts for new developers to procedural steps for operations teams."},"files":[{"bytes":5068,"path":"plugins/team/skills/development/technical-writing/SKILL.md","sha256":"e0e6e9ecf43de72668ffa8bd1789e6f66f4addeb0ce4a78b28c1591038340a83","url":"https://skillfed.io/files/rsmdt/the-startup/technical-writing/153b4538/SKILL.md"}],"id":"rsmdt/the-startup/technical-writing","links":{"html":"https://skillfed.io/rsmdt/the-startup/technical-writing","md":"https://skillfed.io/rsmdt/the-startup/technical-writing.md","repo":"https://github.com/rsmdt/the-startup"},"meta":{"agents_supported":[],"first_seen":"2026-07-28","forks":42,"language":"Shell","last_updated":"2026-05-07","license":"MIT","name":"technical-writing","publisher":"rsmdt","stars":305},"relations":{"categories":["technical-writing","knowledge-management","devops"],"similar":[{"id":"rsmdt/the-startup/architecture-selection"},{"id":"yonatangross/orchestkit/architecture-decision-record"},{"id":"patricio0312rev/skills/adr-writer"},{"id":"rsmdt/the-startup/specify-solution"},{"id":"majesticlabs-dev/majestic-marketplace/create-adr"},{"id":"dirnbauer/webconsulting-skills/architecture-decision-records"},{"id":"akillness/jeo-skills/technical-writing"},{"id":"dawiddutoit/custom-claude/create-adr-spike"},{"id":"shinpr/claude-code-workflows/documentation-criteria"},{"id":"akillness/jeo-skills/changelog-maintenance"}]},"slug":{"owner":"rsmdt","repo":"the-startup","skill":"technical-writing"},"version":"153b4538"}