CommunityEscrita e Ediçãogithub.com

Al0olo/Agents-village

Escreva ou edite documentação, READMEs, descrições de PR e textos de pesquisa no estilo deste repositório. Use sempre que produzir textos destinados a leitores.

O que é Agents-village?

Este skill define um conjunto de regras de estilo para a escrita de documentação e textos voltados a leitores humanos em um repositório. Ele orienta você a produzir conteúdo claro, direto e sem rodeios: frases curtas, uma ideia por parágrafo, e sempre liderar com o ponto principal. O skill enfatiza o uso de exemplos concretos — números, arquivos, comandos ou nomes — em vez de generalizações, e proíbe completamente narrativas de processo, auto-referência e vocabulário vazio (como 'robusto', 'alavancar', 'abrangente'). Além disso, determina que tabelas sejam usadas apenas para comparações e listas apenas para etapas ou itens paralelos. Cada diretório deve ter um `README.md` (o que é, para pessoas) e um `AGENTS.md` (regras para o agente). Documentos voltados a leitores devem ter uma linha de autoria e no máximo uma data; estado operacional vai em `docs/HANDOFF.md` e `docs/handoff/LOG.md`. O skill é compatível com qualquer plataforma de agente de IA que utilize um arquivo SKILL.md, como Claude Code, Cursor ou Codex, e é útil para garantir consistência e clareza em toda a documentação do projeto.

Funciona com~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/Al0olo/Agents-village/tree/HEAD/.claude/skills/docs-style

Installed? Explore more Escrita e Edição skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

Ver original→Navegar por todas as habilidades

Perguntar na sua IA favorita

Abre um novo chat com esta habilidade de agente já pré-carregada.

OpenAIChatGPTClaudeClaudeGeminiGeminiGrokGrokPerplexityPerplexityDeepSeekDeepSeek

Documentação

Estilo da documentação

  • Lidere com o ponto principal. Uma ideia por parágrafo. Frases curtas.
  • Prefira o concreto ao geral: um número, um arquivo, um comando, um nome.
  • Nenhuma narrativa de processo ou auto-referência em documentos voltados a leitores.
  • Sem rodeios: corte "é importante notar", "a fim de", "robusto", "alavancar", "abrangente", "perfeito".
  • Tabelas apenas para comparação; listas apenas para etapas ou itens paralelos.
  • Declare a incerteza uma vez, onde ela se aplica, e diga o que a resolveria.
  • Cada diretório possui um README.md (o que é, para pessoas) e um AGENTS.md (regras que um agente pode seguir). Atualize ambos quando o propósito ou as regras do diretório mudarem.
  • Documentos voltados a leitores trazem uma linha de autoria e no máximo uma data. O estado operacional vai em docs/HANDOFF.md e docs/handoff/LOG.md.
  • Leia de volta como se fosse um estranho. Corte tudo o que ele pularia.

Individual skills in this repo

This repo contains 3 individual skills — each has its own dedicated page.

Al0olo/Agents-village

Design, pre-register, run or analyze an experiment (RQ1, RQ2, RQ3). Use when writing a pre-registration, choosing arms, measures, sample size or statistics, planting facts, or interpreting results.

Al0olo/Agents-village

Branch, commit and open pull requests in this repo. Use whenever creating a branch, writing a commit message, pushing, opening or updating a PR, or when CI fails on a PR.

Al0olo/Agents-village

Read the previous agent's state at the start of a session and write yours at the end. Use at the start and end of every session, after any milestone, decision, failure or environment discovery, and whenever the user says "continue", "pick up", "where are we" or "wrap up".

Habilidades Relacionadas

steipete/notion

Notion CLI/API for pages, Markdown content, data sources, files, comments, search, Workers, and raw API calls.

community

langchain-ai/langchain

The agent engineering platform.

community

bytedance/podcast-generation

Use this skill when the user requests to generate, create, or produce podcasts from text content. Converts written content into a two-host conversational podcast audio format with natural dialogue.

community

composiohq/twitter-algorithm-optimizer

Analyze and optimize tweets for maximum reach using Twitter's open-source algorithm insights. Rewrite and edit user tweets to improve engagement and visibility based on how the recommendation system ranks content.

community

composiohq/competitive-ads-extractor

Extracts and analyzes competitors' ads from ad libraries (Facebook, LinkedIn, etc.) to understand what messaging, problems, and creative approaches are working. Helps inspire and improve your own ad campaigns.

community

upstash/context7

Context7 Platform -- Up-to-date code documentation for LLMs and AI code editors

community
← More Escrita e Edição skills