tech-writer

Generate and maintain ADRs, CLAUDE.md, runbooks, and changelogs.

Updated Mar 8, 2026
One-click install
npx skills add https://github.com/JFrangel/agents --skill tech-writer-jfrangel
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: tech-writer
Source: https://github.com/JFrangel/agents/tree/main/skills/documentation
Command: npx skills add https://github.com/JFrangel/agents --skill tech-writer-jfrangel

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and assets (resource) components.

What problem does it solve?

Corporate teams struggle to keep technical documentation up-to-date and consistent across ADRs, runbooks, CLAUDE.md, and changelogs.

Core Features & Use Cases

  • ADR generation and maintenance with structured context, decisions, and consequences.
  • CLAUDE.md, AGENTS.md and context-rule drafting to standardize IA interfaces.
  • Runbooks, architecture diagrams (Mermaid), and OpenAPI/Swagger reflections from code.
  • Documentation as code with cross-linking and changelog generation to support audits.

Quick Start

Ask me to generate or update ADRs, CLAUDE.md, or runbooks by supplying a concise user_query and context.

Frequently Asked Questions about tech-writer

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

FAQPage Schema
How do I generate ADRs and runbooks from code changes?

You can generate ADRs and runbooks from code changes by providing a concise user query and context to automate technical documentation. This produces standardized templates with structured context, decisions, and consequences.

What is the best way to maintain OpenAPI and AsyncAPI documentation?

Maintaining OpenAPI and AsyncAPI documentation is best handled by reflecting API references directly from code. This approach ensures your API documentation stays synchronized with engineering changes automatically.

Does this approach support Mermaid diagrams for architecture documentation?

Yes, Mermaid diagrams are fully supported for architecture documentation. The documentation-as-code process generates and updates Mermaid diagrams alongside ADRs and runbooks to keep system visuals current.

Can I use this for corporate technical writing with CLAUDE.md files?

Yes, you can use this for corporate technical writing to draft and standardize CLAUDE.md and AGENTS.md files. It standardizes IA interfaces and maintains consistent context rules across engineering teams.

How to automate changelog generation for documentation audits?

Automate changelog generation for audits by applying documentation-as-code with cross-linking. This process updates changelogs in response to code changes, creating structured artifacts that support compliance requirements.

When do I need to update technical documentation across engineering teams?

You need to update technical documentation when code changes occur, ensuring ADRs, runbooks, and changelogs remain consistent. This automation prevents corporate teams from struggling with outdated or fragmented documentation artifacts.