skills.rest
akillness
akillnessCOMMUNITY
Explore all skills by this author →
Website𝕏@akillness0308GitHub

technical-writing

Generate technical documentation for specs, architecture, runbooks, and API docs.

40|9|Updated Jan 4, 2026
Search Tags:#architecture#documentation#runbooks#specs#technical-writing#api-docs
One-click install
npx skills add https://github.com/akillness/oh-my-skills --skill technical-writing-akillness
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writing
Source: https://github.com/akillness/oh-my-skills/tree/main/.agent-skills/technical-writing
Command: npx skills add https://github.com/akillness/oh-my-skills --skill technical-writing-akillness

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Write clear, comprehensive technical documentation across specs, architecture, runbooks, and API docs, reducing ambiguity and onboarding time.

Core Features & Use Cases

  • Structured templates for technical docs (technical specs, system architecture, runbooks, API references)
  • Audience-aware guidance to tailor content for developers, operators, and stakeholders
  • Versioned templates and style guidance to ensure consistency across projects
  • Real-world example: generate a complete architecture document for a new microservice

Quick Start

Create a complete technical documentation draft for a new service using the provided templates and audience guidance.

Frequently Asked Questions about technical-writing

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write technical documentation for a new software architecture?▼

Generate clear technical documentation for software architecture using structured templates that reduce ambiguity and onboarding time. The Skill provides audience-aware guidance to tailor system design content specifically for developers, operators, and stakeholders.

What's the best way to create an operational runbook for a system?▼

Create an operational runbook using structured templates designed for operational playbooks and developer guides. The Skill ensures consistency across projects by applying versioned templates and style guidance tailored to your specific audience.

Can I generate API docs that are tailored for different audiences?▼

Yes, generate API docs with audience-aware guidance that tailors the content for developers, operators, and stakeholders. This approach ensures API references are clear, comprehensive, and consistent across your software projects.

Does this technical writing approach work for technical specs and system design?▼

Yes, the technical writing approach works for technical specs and system design by providing structured templates for architecture documents. It applies consistency checks to reduce ambiguity across software projects, systems design, and developer guides.

How do I ensure consistency across multiple technical documentation projects?▼

Ensure consistency across technical documentation projects by applying versioned templates and built-in style guidance. The Skill performs consistency checks on specs, architecture, runbooks, and API docs to maintain a unified standard.

When do I need structured templates for developer guides and runbooks?▼

You need structured templates for developer guides and runbooks when drafting technical documentation for new services or operational playbooks. They provide audience-aware guidance, ensuring clear, comprehensive coverage across platforms without ambiguity.

Related Skills

Explore More Content & Communication Skills→
hiroshi75hiroshi75

documentation

Generate and maintain technical documentation including READMEs, API references, and runbooks.

Community
Intermediate
rikdcrikdc
2

document

Generate technical documentation from OpenAPI specs and code annotations.

Community
Intermediate
dp-archivedp-archive
1.1k

code-to-diagram

Generate Mermaid.js diagrams from source code and GitHub repositories.

Community
Advanced
jg-chalk-iojg-chalk-io

moai-cc-claude-md

Automates Markdown documentation generation and publication workflows for Claude Code.

Community
Advanced