Skip to content
Back to skills

Documentation

ASecurity

Create and maintain accurate engineering documentation using project-agnostic documentation principles.

  • 3 stars
  • 0 votes
  • 0 copies
  • 3 views
  • Added September 2, 2026
ai-agentsapidocumentation

Works with

  • api

Security analysis

A100/100

Scanned September 2, 2026

npx -y skills add soden46/engineer-flow --skill documentation --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Documentation?

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

Security grade badge for Documentation
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/soden46-documentation/badge)](https://www.skillsdirectory.com/skills/soden46-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: documentation
description: Create and maintain accurate engineering documentation using project-agnostic documentation principles.
metadata:
  internal: true
---

# documentation

Use this skill for README files, setup guides, runbooks, architecture notes, migration guides, and developer documentation.

## Principles

Document actual behavior, not assumed behavior.

Prefer concise and actionable instructions.

Include prerequisites when needed.

Commands and examples should match the current project.

Separate:

- installation
- configuration
- operation
- troubleshooting

Avoid duplicating information already maintained authoritatively elsewhere unless necessary.

When code changes invalidate documentation, update both together.

Do not document nonexistent APIs or configuration.

## Adaptation

Use project evidence to determine the actual language, framework, runtime, and existing conventions.

When stack-specific implementation guidance is needed, prefer project evidence, native framework or language mechanisms, and relevant user-installed specialist skills. Technology-specific guidance must not redefine or weaken the core engineering requirement.

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…