スキル documentation-templates
📦

documentation-templates

安全

Crie Documentação Profissional Rapidamente

Esta skill fornece templates prontos para uso para arquivos README, documentação de API, comentários de código, changelogs e formatos de documentação amigáveis para IA.

対応: Claude Codex Code(CC)
🥉 74 ブロンズ
1

スキルZIPをダウンロード

2

Claudeでアップロード

設定 → 機能 → スキル → スキルをアップロードへ移動

3

オンにして利用開始

テストする

「documentation-templates」を使用しています。 Use documentation-templates para criar um README para uma API Node.js

期待される結果:

Um README.md completo com seções: Título + One-liner, Quick Start, Features, Tabela de Configuration, Link para API Reference, Contributing guidelines, License

「documentation-templates」を使用しています。 Use documentation-templates para documentar um endpoint GET /users

期待される結果:

Documentação de API com descrição do endpoint, Tabela de parâmetros (id: string, required), Códigos de resposta (200, 404) e exemplo de request/response

「documentation-templates」を使用しています。 Use documentation-templates para criar um ADR para escolha de banco de dados

期待される結果:

Documento ADR com Status (Accepted/Deprecated/Superseded), Context (por que a decisão é necessária), Decision (o que foi decidido), Consequences (trade-offs)

セキュリティ監査

安全
v1 • 2/24/2026

All 23 static findings are false positives. The skill contains only markdown documentation templates with no executable code. The detected patterns (external_commands, weak cryptographic algorithms, system reconnaissance) are markdown code fences, plain English text, and API documentation placeholders - not actual security risks.

1
スキャンされたファイル
200
解析された行数
0
検出結果
1
総監査数
セキュリティ問題は見つかりませんでした

検出されたパターン

External Command Execution (False Positive)Weak Cryptographic Algorithm (False Positive)System Reconnaissance (False Positive)
監査者: claude

品質スコア

38
アーキテクチャ
100
保守性
87
コンテンツ
50
コミュニティ
100
セキュリティ
91
仕様準拠

作れるもの

Configuração de Novo Projeto

Estruture rapidamente a documentação para um novo projeto com templates de README, docs de API e changelog.

Padrões de Documentação

Mantenha estilo de documentação consistente em projetos de equipe usando templates padronizados.

Integração com Agente de IA

Crie documentação que agentes de IA como Claude e Codex possam entender e usar efetivamente.

これらのプロンプトを試す

Criar README Básico 
Use a skill documentation-templates para criar um README.md para meu projeto [project type]. Inclua seções Quick Start, Features e Configuration.
Documentar Endpoints de API 
Use a skill documentation-templates para criar documentação de API para minha REST API com endpoints para [list endpoints].
Escrever Comentários de Código 
Use a skill documentation-templates para adicionar comentários JSDoc à minha função que [describe function purpose].
Criar Architecture Decision Record 
Use a skill documentation-templates para criar um ADR para [decision title]. Inclua seções Context, Decision e Consequences.

ベストプラクティス

  • Comece com seções essenciais primeiro (title, quick start, features) antes de adicionar documentação detalhada
  • Use templates como pontos de partida e adapte a estrutura às necessidades do seu projeto
  • Mantenha a documentação atualizada - docs desatualizados são piores que nenhuma documentação
  • Inclua exemplos em sua documentação para ajudar os usuários a entender rapidamente

回避

  • Não copie templates literalmente sem personalizar para o contexto do seu projeto
  • Evite documentar detalhes de implementação em arquivos README voltados ao usuário
  • Não pule a seção Quick Start - usuários querem começar rapidamente
  • Evite usar formatos de documentação desatualizados que agentes de IA não conseguem analisar

よくある質問

Com quais ferramentas esta skill é compatível?
Esta skill funciona com Claude, Codex e Claude Code. Use-a com as ferramentas Read, Glob e Grep.
Preciso modificar os templates?
Sim, templates são pontos de partida. Adapte os placeholders e estrutura para se adequar às necessidades específicas do seu projeto.
Posso usar isso para projetos comerciais?
Sim, esta skill está licenciada sob MIT, permitindo uso comercial com atribuição.
O que é llms.txt?
llms.txt é um formato de documentação projetado para crawlers e agentes de IA. Ele fornece uma visão estruturada que modelos de IA podem facilmente analisar e entender.
Como isso difere de docs auto-gerados?
Esta skill fornece templates escritos por humanos que priorizam clareza e escaneabilidade. Docs auto-gerados frequentemente carecem de estrutura e contexto adequados.
Esta skill pode gerar código real?
Não, esta skill gera apenas estruturas e templates de documentação. Não produz código executável.

開発者の詳細

作成者

sickn33

ライセンス

MIT

リポジトリ

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/documentation-templates

参照

main

ファイル構成

📄 SKILL.md