technical-writer

Generate READMEs, specifications, architecture documents, and runbooks from templates.

3|1|Updated Jul 16, 2025
One-click install
npx skills add https://github.com/MykalMachon/llm-config --skill technical-writer-mykalmachon
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/MykalMachon/llm-config/tree/main/skills/technical-writer
Command: npx skills add https://github.com/MykalMachon/llm-config --skill technical-writer-mykalmachon

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the creation of technical documentation, including READMEs, specifications, architecture docs, and runbooks, saving time and ensuring consistency.

Core Features & Use Cases

  • Documentation Generation: Create README files, specs, runbooks, and architecture documents from solution details.
  • Template Reuse: Apply templates to maintain a consistent structure and tone.
  • Mermaid Diagrams: Include diagrams for architecture and workflow visuals.

Quick Start

Review the technical solution, then generate documentation using the provided templates in the templates folder. Replace placeholders like %PROJECT NAME% with actual values.

Frequently Asked Questions about technical-writer

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

FAQPage Schema
How do I generate a README file for my software project?

Generate a README by reviewing your technical solution details, then use the provided templates to create structured documentation. Replace placeholders like %PROJECT NAME% with actual values to produce a professional README file quickly.

What's the best way to create consistent technical documentation across multiple projects?

Apply reusable templates to maintain consistent structure and tone across READMEs, specifications, architecture documents, and runbooks. Template-driven generation ensures standardized file organization and placeholder substitution across your projects.

Can I include diagrams in my technical documentation?

Yes, the Skill supports optional Mermaid diagrams for architecture and workflow visuals within documentation outputs. Include diagrams to enhance clarity in architecture documents and technical specifications alongside your generated content.

How do I document architecture decisions and system specifications?

Document technical decisions and system architecture by generating specification and architecture documents from your solution details using templates. The Skill handles template substitution and standardized formatting to create professional architecture documentation.

What documentation types can I create with this approach?

Create READMEs, specifications, architecture documents, and runbooks aligned with repository conventions. Template-driven generation supports diverse documentation needs with consistent structure and automated placeholder replacement across all document types.

Do I need existing documentation to get started?

No, you start by reviewing your technical solution and selecting appropriate templates from the templates folder. The Skill generates documentation from scratch using templates and placeholder substitution, requiring only your project details and solution information.