Receber por email
← Voltar para o catálogo

documentation

Use this skill whenever writing any document - plans, proposals, docs, documentation, brainstorm docs, notes, guides, specs, designs, READMEs, or any markdown file output.

367estrelas
Atualizado há 4 meses

Ver no GitHub ↗

Como adicionar

/plugin marketplace add aiskillstore/marketplace

O comando exato pode variar conforme o repositório. Confira o README no GitHub.

Para o autor da skill

Cole no README do seu repo

Mostra que sua skill está catalogada na Skillteca, gera backlink e tráfego rastreável.

[![Skillteca](https://www.skillteca.com.br/api/badge/documentation-mpsz39od/svg)](https://www.skillteca.com.br/skills/documentation-mpsz39od)

Alerta por categoria

Receba novas skills de Escrita e Conteúdo toda segunda

1 email curto, só com as skills novas de Escrita e Conteúdo. 4 minutos de leitura, sem spam, cancela com 1 clique.

Você confirma o email no primeiro envio. Sem spam. Cancela com 1 clique.

Ler descrição completa

Documentation Skill

When creating any written document, follow these principles.

Always Write to a File

Never dump long-form content to the terminal. Always write to a .md file and tell the user where it is.

Use sensible naming - the topic and optionally a timestamp if uniqueness matters.

Make It Readable

  • Use headers to create structure
  • Break up walls of text with bullets, lists, or tables
  • Use code blocks for commands and configs
  • Keep paragraphs short
  • Use formatting (bold, code, etc.) to aid scanning

Diagrams

When architecture, flows, or relationships would benefit from visualisation, use the mermaid skill.

Tone

Match the document's purpose:

  • Technical docs → clear and direct
  • Proposals → persuasive but honest
  • Brainstorms → exploratory, capture ideas freely
  • Plans → actionable, concrete steps

Emojis

Use emojis for visual navigation (section headers, callouts) when they help. Don't overdo it. Skip them entirely if the document is formal or technical.

That's It

Don't overthink it. Write clearly, structure logically, output to a file.

Compartilhar X LinkedIn