technical-documentation

Document interface surfaces and usage patterns with frontmatter-based metadata.

86|9|Updated Jun 5, 2026

Search Tags:#documentation #readme #technical-writing #api-docs #information-architecture #documentation-site #cli-help

Ready to run

npx skills add https://github.com/magnus919/hermes-profiles --skill technical-documentation-magnus919

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: technical-documentation
Source: https://github.com/magnus919/hermes-profiles/tree/main/skills/technical-documentation
Command: npx skills add https://github.com/magnus919/hermes-profiles --skill technical-documentation-magnus919

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Technical documentation methodology provides a structured approach to producing clear, maintainable documentation that effectively communicates interfaces, usage patterns, and architecture across API references, READMEs, CLI help text, agent-facing docs (AGENTS.md), developer guides, and documentation site information architecture.

Core Features & Use Cases

Establishes a frontmatter-driven metadata model for discovery and consistency across documentation artifacts.
Defines core documentation types (API references, READMEs, CLI help text, AGENTS.md, developer guides, and IA) with recommended patterns and cross-referencing strategies.
Supports scalable documentation workflows and information architecture for large projects, enabling maintainable collaboration across teams.

Quick Start

Create a basic API reference and a README using this methodology to organize your documentation.

Frequently Asked Questions about technical-documentation

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

FAQPage Schema

How do I structure API references and READMEs for better developer understanding?▼

Structure API references and READMEs using a frontmatter-driven metadata model to standardize interface surfaces and usage patterns. This methodology ensures maintainability and discoverability across documentation artifacts for better developer understanding.

What is frontmatter-based metadata and how does it improve documentation sites?▼

Frontmatter-based metadata establishes a structured discovery and consistency model for documentation sites. It standardizes information architecture, enabling maintainable collaboration and scalable documentation workflows across large project teams.

Can I use this methodology to generate CLI help text and AGENTS.md files?▼

Yes, this methodology supports generating CLI help text and agent-facing AGENTS.md files. It defines core documentation types with recommended patterns and cross-referencing strategies to standardize structure across developer guides.

What's the best way to standardize technical writing across multiple documentation types?▼

Standardize technical writing by applying defined reference patterns and a frontmatter-driven metadata model across API references, READMEs, CLI help, and developer guides. This approach ensures consistent structure and cross-referencing for scalable workflows.

How do I maintain information architecture for large project documentation sites?▼

Maintain information architecture for large documentation sites by establishing a frontmatter-driven metadata model and cross-referencing strategies. This methodology supports scalable documentation workflows and enables maintainable collaboration across teams.