ag-documentar-projeto

ag-documentar-projeto is a skill for Claude Code from andregusman-raiz/a-gusman-claude. It costs 31 tokens per session (694 once invoked), scanned A, original, MIT.

Project-documentation tooling that creates and updates README files, API documentation, guides, changelogs, and architecture decision records (ADRs). It keeps these documents aligned with the current code after significant changes.

In plain words
What is it for?
Use it to document setup, API endpoints and data structures, practical procedures, release changes, and architecture decisions.
Why use it?
It reduces the risk of documentation becoming outdated or being saved in the wrong project or folder. It also keeps common documentation types consistent.

Skill for Claude Code

Written for Claude Code: disable-model-invocation in frontmatter. Also seen: model in frontmatter; mentions subagents.

Good fit Use it to document setup, API endpoints and data structures, practical procedures, release changes, and architecture decisions.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/andregusman-raiz/a-gusman-claude/ag-documentar-projeto
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add andregusman-raiz/a-gusman-claude --skill ag-documentar-projeto
Clone the repo
git clone --depth 1 https://github.com/andregusman-raiz/a-gusman-claude

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for ag-documentar-projeto

README.md
[![agentmods](https://agentmods.dev/badge/skills/andregusman-raiz/a-gusman-claude/ag-documentar-projeto/github.svg)](https://agentmods.dev/skills/andregusman-raiz/a-gusman-claude/ag-documentar-projeto)
Your own site
<a href="https://agentmods.dev/skills/andregusman-raiz/a-gusman-claude/ag-documentar-projeto"><img src="https://agentmods.dev/badge/skills/andregusman-raiz/a-gusman-claude/ag-documentar-projeto/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for ag-documentar-projeto

Your own site · 80×15
<a href="https://agentmods.dev/skills/andregusman-raiz/a-gusman-claude/ag-documentar-projeto"><img src="https://agentmods.dev/badge/skills/andregusman-raiz/a-gusman-claude/ag-documentar-projeto.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 31 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 694 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe. Third-party audits
  • NVIDIA SkillSpector warn 7 Sept 2026
SkillSpector: 1 finding, up to medium

These are SkillSpector’s own severities. On a checked sample its high-severity flags on skills were ~96% false positives — a documented command, a public API, a “never do X” rule — so we show them as a caution to read, not a verdict. Why →

  • medium Excessive Agency · line 4
    Skill selects an external model or provider that may use a different account or billing plan than the operator expects. Undisclosed model switches can cause unexpected cost or quota consumption.
    Fix: Remove the model/provider override or disclose it prominently and require explicit operator approval before invoking an external coding CLI or billed model.
How audits are shown
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00031 $0.00694
Opus 5 $0.00015 $0.00347
Sonnet 5 $0.00006 $0.00139
Haiku 4.5 $0.00003 $0.00069

Measured 12d ago against content hash 01bbe04b1d30, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-11, from the pricing page.

Security

Grade A, and why

ag-documentar-projeto scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 12d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/ag-documentar-projeto/SKILL.md · 64 lines

How it starts

The opening of the file, as written. The whole thing — 64 lines — stays where its author put it; the contents beside it link to each section on GitHub.

ag-documentar-projeto — Documentar Projeto

Spawn the ag-documentar-projeto agent to create and maintain project documentation: README, API docs, guides, changelog, and ADRs.

Docs Location (OBRIGATORIO)

Antes de salvar qualquer arquivo, resolver PROJECT_ROOT via git rev-parse --show-toplevel (ou usar o path do argumento). Se for $HOME/Claude (workspace raiz) — PARAR e perguntar qual projeto. Detalhes: ~/Claude/.claude/shared/patterns/docs-location.md. Hook docs-location-guard.sh bloqueia escrita em ~/Claude/docs/.

Invocation

Use the Agent tool with:

  • subagent_type: ag-documentar-projeto
  • mode: auto
  • run_in_background: false
  • prompt: Compose from template below + $ARGUMENTS

Prompt Template

Projeto: [CWD or user-provided path]
Tipo: [readme|api|guia|changelog|adr]
Escopo: [modulo ou area especifica, se aplicavel]


Crie ou atualize a documentacao solicitada mantendo sincronia com o codigo atual.
README deve permitir setup em 10 min. API docs devem cobrir endpoints e schemas.
Guias devem ser praticos com exemplos. ADRs seguem template em docs/adr/.

Important

  • ALWAYS spawn as Agent subagent — do NOT execute inline
  • After spawning, confirm to the user

Output

  • README com setup em 10 min (install, build, run, test)
  • Documentacao de API (endpoints, schemas, auth, error codes)
  • Guides de uso (praticos com exemplos)
  • Changelog formatado e ADRs em docs/adr/

Anti-Patterns

  • NUNCA documentar codigo obvio — docs repetindo codigo sao ruido; documentar "why", nao "what"
  • NUNCA criar docs desconectados — docs nao atualizados com codigo enganam; manter sincronizados
  • NUNCA pular ADR para decisoes significativas — sem ADR, ninguem sabe a justificativa

Quality Gate

  • Doc reflete estado atual do codigo?
  • Dev novo consegue setup em 10 min seguindo README?
  • Decisoes arquiteturais tem ADR correspondente?

Regra PDF → Markdown (obrigatoria — economia de tokens)

Qualquer PDF consumido por esta skill DEVE ser convertido ANTES via markitdown: bash ~/Claude/.claude/scripts/pdf2md.sh <arquivo.pdf> → Read/Grep no .md gerado (cache automatico). NUNCA Read direto de .pdf para extrair texto. Excecao visual (layout/slides): converter primeiro, Read multimodal depois. Enforcement: hook pdf-read-guard.sh. Detalhes: .claude/rules/pdf-markitdown.md.

Read the full file on GitHub · 64 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 12d ago First seen · 64 lines · 31 tokens per session scan A 01bbe04b1d30

Subscribe to this mod's changes

ag-documentar-projeto is a skill published in the GitHub repository andregusman-raiz/a-gusman-claude (19 stars, last pushed 3d ago), licensed MIT. It adds 31 tokens to every session and 694 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other skills, from other repositories

timeline-creator

Create HTML timelines and project roadmaps with Gantt charts, milestones, phase groupings, and progress indicators. Use when users request timelines, roadmaps, Gantt charts, project schedules, or milestone visualizations.

mhattingpete/claude-skills-marketplace · 47 tokens

implement-issue

Drive a GitHub issue from branch to pull request — read the issue, create a feature branch, implement the change, run the project's build and tests, then commit, push, and open a PR. Language and build-tool agnostic. Use when asked to implement, fix, or resolve a GitHub issue by number.

alexmond/alexmskills · 69 tokens

ticket-triage

Rank the open tickets, work out what is genuinely startable versus blocked, run the startable ones in parallel through to merged — then KEEP GOING: re-triage every time an agent finishes, so the backlog drains without being re-asked. Use for "what's next", "review tickets", "triage the backlog", "prioritise", "start…

alexmond/alexmskills · 168 tokens

daily-working

End-to-end pipeline: pull a task from the project's task tracker by ID (Redmine or GitHub Issues today, more addable via a new adapter), sanity-check and impact-assess it against the codebase before touching anything, implement it with the Claude CLI, verify the result in a real browser via the Claude Chrome extension…

tms-tungnguyen3/daily_working · 98 tokens

project-updates

Drafts Linear project status updates for each project the user leads, following the Done / In Progress / Next / Blockers template. Gathers context from Linear issues and comments, git history across configured repos, GitHub PRs, Slack mentions, Notion edits, and Gmail/Calendar. Never auto-posts — always shows the…

mostafa-drz/claude-skills · 122 tokens

daily-brief

Surfaces recent updates relevant to you from GitHub, Linear, Slack, and other configured sources — PR reviews, new assignments, ticket changes, mentions, and CI failures. Use when starting work, catching up after being away, or prepping for standup.

mostafa-drz/claude-skills · 56 tokens