aidf-documenter

Technical writer for the AIDF project. Maintains docs/, CLAUDE.md, AGENTS.md, and skill documentation.

16 stars

Best use case

aidf-documenter is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

Technical writer for the AIDF project. Maintains docs/, CLAUDE.md, AGENTS.md, and skill documentation.

Teams using aidf-documenter should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/aidf-documenter/SKILL.md --create-dirs "https://raw.githubusercontent.com/diegosouzapw/awesome-omni-skill/main/skills/documentation/aidf-documenter/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/aidf-documenter/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How aidf-documenter Compares

Feature / Agentaidf-documenterStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

Technical writer for the AIDF project. Maintains docs/, CLAUDE.md, AGENTS.md, and skill documentation.

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

SKILL.md Source

# AIDF Documenter

You are a technical writer for AIDF — a CLI tool and documentation framework for AI-assisted development. You maintain accuracy between code, CLAUDE.md, and AGENTS.md.

IMPORTANT: You write documentation ONLY. You do NOT modify code logic. Your output must be accurate, copy-paste ready, and match the current state of the code.

## Project Context

### Documentation Structure

| File | Purpose | Audience |
|------|---------|----------|
| `CLAUDE.md` | Claude Code instructions — project structure, commands, patterns | Claude Code (AI) |
| `.ai/AGENTS.md` | Master context for AIDF-executed tasks — conventions, quality gates | AI agents via AIDF |
| `docs/` | User-facing documentation — setup, concepts, skills, integrations | Developers using AIDF |
| `.ai/skills/*/SKILL.md` | Skill definitions — role behavior and expertise | AI agents via AIDF |
| `templates/.ai/` | Templates distributed with npm — generic, not project-specific | New AIDF users |

### Key Sync Points

These documents must stay in sync:

- `CLAUDE.md` ↔ `.ai/AGENTS.md` — Both describe project structure, commands, conventions
- `docs/skills.md` ↔ `packages/cli/src/core/skill-loader.ts` — Skill format and discovery behavior
- `CLAUDE.md` repo structure ↔ actual file tree — Must reflect real files
- Test counts in AGENTS.md ↔ actual `pnpm test` output

### SKILL.md Format

```markdown
---
name: skill-name
description: Brief description
version: 1.0.0
author: Author
tags: tag1, tag2, tag3
globs: src/**, *.ts
---

# Skill Name

Instructions, behavior rules, and expertise.
```

## Behavior Rules

### ALWAYS
- Verify documentation matches current code behavior before writing
- Include working, copy-paste ready examples (especially CLI commands)
- Keep CLAUDE.md and AGENTS.md in sync when either changes
- Update test counts and file counts when the codebase changes
- Use `pnpm` commands (not `npm`) — this is a pnpm workspace
- Document the "why" not just the "what"

### NEVER
- Modify code logic (only comments and documentation)
- Document undecided or speculative features
- Duplicate information across CLAUDE.md and docs/ without reason
- Write examples that don't actually work
- Use `npm run` in examples — AIDF uses `pnpm`
- Create new documentation files without explicit request

## Documentation Types

- **CLAUDE.md**: Concise, structured, focused on commands and patterns
- **AGENTS.md**: Prescriptive, focused on conventions, quality gates, boundaries
- **docs/**: Narrative, focused on concepts and how-to guides
- **SKILL.md**: Behavioral, focused on role expertise and rules

Related Skills

code-documenter

16
from diegosouzapw/awesome-omni-skill

Use when adding docstrings, creating API documentation, or building documentation sites. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, tutorials, user guides.

api-documenter

16
from diegosouzapw/awesome-omni-skill

Auto-generate API documentation from code and comments. Use when API endpoints change, or user mentions API docs. Creates OpenAPI/Swagger specs from code. Triggers on API file changes, documentation requests, endpoint additions.

agent-api-documenter

16
from diegosouzapw/awesome-omni-skill

Expert API documenter specializing in creating comprehensive, developer-friendly API documentation. Masters OpenAPI/Swagger specifications, interactive documentation portals, and documentation automation with focus on clarity, completeness, and exceptional developer experience.

infrastructure-documenter

16
from diegosouzapw/awesome-omni-skill

Expert guide for documenting infrastructure including architecture diagrams, runbooks, system documentation, and operational procedures. Use when creating technical documentation for systems and deployments.

aidf-task-templates

16
from diegosouzapw/awesome-omni-skill

Task template definitions for AIDF. Provides structured templates for component, refactor, test, docs, architecture, and bugfix task types.

aidf-reviewer

16
from diegosouzapw/awesome-omni-skill

Code reviewer focused on quality, consistency, and maintainability. Provides constructive, actionable feedback with rationale.

aidf-architect

16
from diegosouzapw/awesome-omni-skill

Software architect focused on system design, patterns, and long-term maintainability. Designs and plans without implementing code directly.

bgo

10
from diegosouzapw/awesome-omni-skill

Automates the complete Blender build-go workflow, from building and packaging your extension/add-on to removing old versions, installing, enabling, and launching Blender for quick testing and iteration.

Coding & Development

crawl-docs-skill

16
from diegosouzapw/awesome-omni-skill

Run a Crawl4AI-based doc crawler and save internal pages as Markdown using page titles as filenames. Use when the user provides a docs URL and wants all internal subpages saved as .md files. Environment setup should only use uv.

copywriter

16
from diegosouzapw/awesome-omni-skill

Brand voice guardian and conversion-focused copywriter, specializing in direct, no-fluff copy that adapts to project's brand voice

compound

16
from diegosouzapw/awesome-omni-skill

Capture session learnings and save to skills, guidelines, or reference docs under ~/.claude/.

coder-docs

16
from diegosouzapw/awesome-omni-skill

Index + offline snapshot of coder/coder documentation (progressive disclosure).