Skip to content
Back to skills

Technical Documentation

ASecurity

Produce precise developer and operator documentation from verified implementation, interfaces, constraints, examples, and failure behavior.

  • 16 stars
  • 0 votes
  • 0 copies
  • 1 view
  • Added September 11, 2026
ai-agentsapidocumentation

Works with

  • api

Security analysis

A100/100

Scanned September 11, 2026

npx -y skills add Dadmin88/hermes-profile-packs --skill technical-documentation --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Technical Documentation?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Technical Documentation
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/dadmin88-technical-documentation/badge)](https://www.skillsdirectory.com/skills/dadmin88-technical-documentation)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: technical-documentation
description: Produce precise developer and operator documentation from verified implementation, interfaces, constraints, examples, and failure behavior.
---
# Technical Documentation

Use for READMEs, API docs, architecture explanations, runbooks, migration guides, developer setup, and integration docs.

## Procedure
1. Verify the current implementation, version, interfaces, and supported environments.
2. Identify the technical audience and the task or mental model they need.
3. Document prerequisites, contracts, invariants, configuration, and examples using exact names and commands.
4. Explain failure modes and recovery where operationally important.
5. Keep conceptual explanation separate from step-by-step procedures.
6. Run commands or examples where practical and ensure code samples are internally consistent.
7. Remove stale references and implementation archaeology that does not help a current user.

## Quality gate
A competent reader should be able to use or operate the system from the documentation without reverse-engineering the codebase first.

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…