Technical Writing
Technical Writing guides you through creating durable internal documentation for builders and operators—specs, architecture decisions, runbooks, migration paths, and implementation guides. It helps you classify your document type, gather evidence, choose the right structure, and apply mode-specific writing rules to keep technical knowledge clear and actionable.
Technical Writing helps you create internal technical documentation like specs, architecture docs, ADRs, runbooks, and migration guides for engineering teams.
AI-generated summary based on this skill's SKILL.md
Decision gist · record as of 2026-07-28
Technical Writing helps you create internal technical documentation like specs, architecture docs, ADRs, runbooks, and migration guides for engineering teams. Technical Writing guides you through creating durable internal documentation for builders and operators—specs, architecture decisions, runbooks, migration paths, and implementation guides. It helps you classify your document type, gather evidence, choose the right structure, and apply mode-specific writing rules to keep technical knowledge clear and actionable.
Use it when
- Technical Writing emphasizes classifying your document type before you start writing.
- Technical Writing teaches you to develop clarity and structure for different audiences by understanding document classification.
Install
akillness/jeo-skills/technical-writing · repository language: TypeScript
generated, unverified - the skill's exact subdirectory could not be determined; check the repository on GitHub
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 technical documentation that stays clear and actionable?
Technical Writing helps you create durable internal documentation by first classifying your document type—whether it's a spec, architecture decision, runbook, or implementation guide. Once you know your document's purpose, you gather evidence, choose the right structure for that mode, and apply mode-specific writing rules. This approach ensures your technical knowledge remains clear and actionable for builders and operators who depend on it.
What are the best practices for technical writing?
Technical Writing emphasizes classifying your document type before you start writing, then structuring content according to that mode's conventions. Best practices include gathering solid evidence to support your claims, choosing structures that match your document's purpose, and applying writing rules specific to your format. This systematic approach helps you explain complex technical concepts in accessible language while keeping documentation professional and usable.
How do I improve my technical writing skills?
Technical Writing teaches you to develop clarity and structure for different audiences by understanding document classification, evidence gathering, and mode-specific guidelines. You learn to explain complex technical concepts in accessible language, organize content logically, and apply professional standards. The skill guides you through templates and frameworks for specs, architecture decisions, runbooks, migration paths, and implementation guides—all essential for builders and operators.
What templates and guidelines does Technical Writing provide?
Technical Writing offers structured guidance for multiple document types: specifications, architecture decisions, runbooks, migration paths, and implementation guides. For each type, you learn the appropriate structure, evidence requirements, and mode-specific writing rules. These templates and guidelines help you create professional technical documentation that remains durable and actionable for your team.
How can I structure technical documents effectively?
Technical Writing teaches you to structure documents by first identifying your document type, then applying the structure conventions that match that mode. Whether you're documenting an API, code implementation, architecture decision, or operational runbook, the skill guides you through evidence gathering and organization principles. Proper structure ensures your technical content serves builders and operators with clarity and precision.
How do I write clear technical content for different audiences?
Technical Writing helps you improve clarity and structure by tailoring your approach to your audience and document purpose. You learn to classify your document type, gather relevant evidence, and apply writing rules specific to that mode. This ensures engineers, operators, and other technical audiences can quickly understand complex concepts, find what they need, and act on the information confidently.
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 › “Learn best practices and techniques for writing clear technical documentation”
Give your agent the search over MCP, or paste the wish link into any chat. No install? Search from any chat →
Related skills
Presentation Builder creates actual slide decks when you need a shareable presentation artifact—investor pitches, roadmap reviews, launch decks, architecture walkthroughs, workshops, or game pitches. It handles the full workflow from outline through visual iteration to export in HTML, PPTX, PDF, Google Slides, or Figma Slides, routing non-deck work like specs or tutorials to other skills.
Documentation Patterns offers structured templates for READMEs, Architecture Decision Records, OpenAPI 3.1 specifications, changelogs, and technical writing conventions. Use this skill when establishing documentation standards, onboarding contributors, recording architectural decisions, or maintaining consistent API and release documentation across your projects.
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.
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.
Documentation and ADRs helps teams record the reasoning behind significant technical decisions through structured Architecture Decision Records. Store decisions in `docs/decisions/` with context, alternatives considered, and consequences so future engineers and AI agents understand not just what was built, but why.
This skill generates Architecture Decision Records (ADRs) that capture the context, decision, and consequences of significant technical choices. It guides you through gathering essential information, selecting from three formats (MADR, Nygard, or Y-Statement), and produces a structured document that preserves reasoning for future engineers.
More skills architecture-decision-records (MIT)