technical-writing
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—from high-level concepts for new developers to procedural steps for operations teams.
Technical-writing creates architectural decision records and other technical documentation tailored to your audience and use case.
AI-generated summary based on this skill's SKILL.md
Decision gist · record as of 2026-05-07
Technical-writing creates architectural decision records and other technical documentation tailored to your audience and use case. 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—from high-level concepts for new developers to procedural steps for operations teams.
Use it when
- technical-writing generates four primary documentation types: architectural decision records for design choices.
- technical-writing creates API documentation that includes endpoints, request/response schemas, authentication details, and usage examples.
Verify before relying
Read SKILL.md below before installing (3 files). Open directory: indexed for reading, not audited.
Install
rsmdt/the-startup/technical-writing · repository language: Shell
Open directory. Skills are indexed for reading, not audited. Review a skill's body before installing it.
Frequently asked questions
AI-generated answers based on this skill's SKILL.md and metadata
How to write architectural decision records?
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.
What types of documentation does technical-writing produce?
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.
How do I document API endpoints with technical-writing?
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.
Can technical-writing help create incident response runbooks?
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.
How does technical-writing prevent documentation drift?
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.
What's included in system architecture documentation for onboarding?
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.
SKILL.md
Rendered from the published skill. Quoted content, verbatim.
Persona
Act as a technical documentation specialist who creates and maintains documentation that preserves knowledge, enables informed decision-making, and supports system operations. You select the right documentation type for the situation and apply audience-appropriate detail.
Documentation Request: $ARGUMENTS
Interface
Document { type: ADR | SystemDoc | APIDoc | Runbook audience: Developers | Operations | Business | Mixed detailLevel: HighLevel | Technical | Procedural status: Draft | Proposed | Accepted | Deprecated | Superseded }
State { request = $ARGUMENTS docType: ADR | SystemDoc | APIDoc | Runbook audience: Developers | Operations | Business | Mixed context = {} document = null }
Constraints
Always: - Document the context and constraints that led to a decision before stating the decision itself. - Tailor documentation depth to its intended
(truncated - see the full file via the links below)
File tree — 3 files
plugins/team/skills/development/technical-writing/SKILL.md
plugins/team/skills/development/technical-writing/templates/adr-template.md
plugins/team/skills/development/technical-writing/templates/system-doc-template.md
Let your AI agent find skills like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 56,283 agent skills by what they can do, searchable in plain language.
wish › “Create architectural decision records to document design choices and trade-offs”
Give your agent the search over MCP, or paste the wish link into any chat. No install? Search from any chat →
Related skills
Architecture Selection helps teams pick the best system design by evaluating patterns against team size, domain complexity, scaling needs, and operational maturity. It scores candidates using weighted criteria, documents trade-offs, and provides migration paths—avoiding resume-driven choices and premature optimization. Use it to design new systems, plan migrations, or review existing architectures.
This skill provides templates and guidance for creating Architecture Decision Records—lightweight documents that preserve the reasoning behind major technical choices. It walks you through the Nygard format, covering context, decision, consequences, and alternatives, plus best practices for lifecycle management and team review. Use it when evaluating trade-offs or recording decisions that shape your system's future.
ADR Writer guides you through building comprehensive Architecture Decision Records that capture the reasoning behind key technical choices. It provides a structured template covering context, decision rationale, alternatives evaluated, tradeoffs made, and consequences—helping teams document and communicate architecture decisions clearly.
specify-solution guides you through building solution design documents (SDDs) that capture how your system will be built. It structures your architecture decisions as traceable ADRs, validates that every requirement maps to a component, and ensures your design is complete and conflict-free before implementation begins.
Create ADRs that capture the reasoning behind significant technical choices, including context, alternatives considered, and trade-offs. The skill guides you through gathering implementation details, identifying decision drivers, and structuring records that help future developers understand why architectural choices were made.
Create and maintain architecture decision records (ADRs) using established conventions, templates, and a built-in validator. The skill guides you through prospective and retrospective record creation, enforces quality standards like one decision per record and credible alternatives, and helps manage decision lifecycles with status tracking and supersession links. Use it to build a durable, reviewable record of why architecturally significant choices were made.
More skills Create Adr Spike (unlicensed) · documentation-criteria (MIT) · Technical Writing (unlicensed)