skills.rest
AbsolutelySkilled
AbsolutelySkilledOFFICIAL
Explore all skills by this author →
GitHub

technical-writing

Generate structured Markdown templates for API docs, tutorials, ADRs, and runbooks.

207|31|Updated Mar 14, 2026
Search Tags:#architecture#templates#documentation#adr#tutorials#runbooks#api-docs
One-click install
npx skills add https://github.com/AbsolutelySkilled/AbsolutelySkilled --skill technical-writing-absolutelyskilled
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writing
Source: https://github.com/AbsolutelySkilled/AbsolutelySkilled/tree/main/skills/technical-writing
Command: npx skills add https://github.com/AbsolutelySkilled/AbsolutelySkilled --skill technical-writing-absolutelyskilled

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Documentation that is clear, accurate, and maintainable accelerates onboarding, reduces incidents, and aligns engineers on system design. This skill provides structured guidance and templates to produce API docs, tutorials, architecture docs, ADRs, and runbooks.

Core Features & Use Cases

  • API documentation templates for endpoints and schemas
  • Tutorials and getting-started guides to onboard new engineers
  • Architecture documentation and ADR templates to capture decisions
  • Runbooks with operational procedures and escalation paths
  • Reference materials that link to the included templates in references/

Quick Start

Provide a ready-to-publish API documentation draft for a selected endpoint.

Frequently Asked Questions about technical-writing

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

FAQPage Schema
How do I write API documentation for my software endpoints?▼

API documentation requires structured Markdown templates for endpoints and schemas. This skill generates ready-to-publish drafts conforming to a frontmatter-driven YAML schema, ensuring your API docs remain clear and maintainable.

What is the best way to structure architecture decisions and ADRs?▼

Architecture Decision Records capture engineering choices to align teams on system design. Using structured ADR templates with frontmatter-driven YAML schemas ensures your architecture documentation remains consistent and easy to maintain.

How do I create runbooks with operational procedures and escalation paths?▼

Runbooks document operational procedures and escalation paths to reduce incidents. This skill provides structured Markdown templates that define escalation steps, ensuring your engineering runbooks are accurate and actionable.

Can I use these documentation templates for developer onboarding tutorials?▼

Tutorials and getting-started guides are designed specifically to onboard new engineers. The skill produces structured Markdown templates that accelerate developer onboarding and maintain documentation quality across software projects.

Does this skill require any specific dependencies to generate documentation?▼

No dependencies are required to generate documentation templates. The skill operates independently, producing structured Markdown outputs for API docs, tutorials, ADRs, and runbooks using a frontmatter-driven YAML schema.

Why does my software documentation need a frontmatter-driven YAML schema?▼

A frontmatter-driven YAML schema standardizes your software documentation structure. It ensures that API docs, tutorials, and runbooks conform to consistent metadata formats, making them easier to parse, maintain, and publish.

Related Skills

Explore More Content & Communication Skills→
Vivekmano27Vivekmano27

api-designer

Create standards-compliant REST and GraphQL API specifications in OpenAPI YAML or Markdown.

Community
Advanced
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate
oimiragieooimiragieo
36

doc-generator

Generate API documentation, developer guides, and OpenAPI/Swagger specs from code.

Community
Advanced
thimsluggathimslugga

documentation-templates

Generate standardized documentation templates for README, API references, and code comments.

Community
Intermediate