skills.rest
revan710517539
revan710517539COMMUNITY
Explore all skills by this author →
GitHub

technical-writing

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

Updated Aug 27, 2026
Search Tags:#architecture#documentation#specifications#runbooks#technical-writing#api-docs#developer-docs
One-click install
npx skills add https://github.com/revan710517539/SuperTeams --skill technical-writing-revan710517539
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writing
Source: https://github.com/revan710517539/SuperTeams/tree/main/skills/technical-writing
Command: npx skills add https://github.com/revan710517539/SuperTeams --skill technical-writing-revan710517539

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Write clear, comprehensive technical documentation across specs, architecture, runbooks, and API references to reduce ambiguity and accelerate project onboarding.

Core Features & Use Cases

  • Guided document types: Technical Specification, Architecture Document, Runbook, and API Documentation
  • Audience-aware guidance for developers, DevOps, managers, and end users
  • Templates, checklists, and best-practice guidelines with examples and diagrams
  • Real-world use case: create a system architecture doc for a new microservices platform including data flows and API contracts
  • Visual aids and diagrams to support clarity and consistency

Quick Start

Draft a complete architecture document for a new service, including goals, data flows, and API contracts.

Frequently Asked Questions about technical-writing

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

FAQPage Schema
How do I write architecture documentation for a microservices platform?▼

Generate comprehensive architecture documentation by defining system goals, data flows, and API contracts using structured templates, diagrams, and consistent terminology to ensure publish-ready quality and accelerate onboarding.

What is the best way to create API documentation for developers?▼

Create developer-focused API documentation by applying structured templates, best-practice guidelines, and audience-aware guidance to produce clear, comprehensive API references with consistent terminology.

Can I generate operations runbooks tailored for DevOps workflows?▼

Generate operations runbooks tailored for DevOps workflows by applying audience-aware guidance, structured templates, and best-practice checklists to produce clear, comprehensive operational documentation.

Does this technical writing skill support audience-specific documentation?▼

Yes, this technical writing skill supports audience-specific documentation by providing audience-aware guidance tailored for developers, DevOps, managers, and end users to ensure clear, impactful artifacts.

How do I structure a technical specification document?▼

Structure a technical specification document using guided templates, best-practice guidelines, and checklists to ensure completeness, reduce ambiguity, and produce publish-ready quality artifacts.

When should I use structured templates for developer docs?▼

Use structured templates for developer docs when you need consistent terminology, completeness, and reuse across engineering workflows to produce publish-ready quality artifacts such as developer guides and API references.

Related Skills

Explore More Content & Communication Skills→
ilandahanilandahan
9

aid-tech-spec

Generate a technical specification from PRDs and requirements.

Community
Advanced
unfinishablemapunfinishablemap
3

expand-topic

Generate a publish-ready article draft from a topic prompt.

Community
Intermediate
GS1NedGS1Ned

diagram-generator

Generate architecture, database, component, and sequence diagrams using Mermaid syntax.

Community
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced