Pular para o conteúdo
Skillpedia
Documentação101 mil · #413

docs-page

Gera uma página de documentação com navegação e índice. Perfeito para tutoriais, guias e referências de API.

O que ela faz

Esta ferramenta cria uma página de documentação completa em um único arquivo HTML. Ela organiza o conteúdo em três colunas: um menu de navegação à esquerda, o corpo principal do texto no centro e um índice do lado direito.

Quando usar

  • ✓Quando você precisa de uma página de guia ou tutorial.
  • ✓Ao gerar uma referência de API.
  • ✓Para criar documentação técnica detalhada.

Exemplo do que pedir para a IA

“Crie uma página de documentação para a função de login do usuário, incluindo exemplos de código e notas de aviso.”

Quer saber mais? Abra as seções abaixo.

Como usar

O jeito mais fácil: copie a mensagem abaixo e cole no Claude, ChatGPT, Cursor ou outra IA. Ela lê a skill e segue as instruções.

Link da skill

https://github.com/nexu-io/open-design/blob/main/design-templates/docs-page/SKILL.md

Mensagem pronta para colar

Use esta skill para me ajudar: https://github.com/nexu-io/open-design/blob/main/design-templates/docs-page/SKILL.md Leia o arquivo SKILL.md desse link e siga as instruções dele na minha tarefa.
Como funciona

A ferramenta lê as instruções de design, escolhe um tópico relevante e organiza o conteúdo em três colunas usando CSS Grid. Ela garante que o texto seja legível e o código seja formatado corretamente.

Instalação

Jeito mais fácil: copie o link da skill e cole no Claude, ChatGPT ou Cursor pedindo para seguir as instruções.

No terminal (Claude Code, Codex, Cursor), na pasta do projeto:

npx skills add nexu-io/open-design --skill docs-page

Ou baixe só o arquivo:

curl -L https://raw.githubusercontent.com/nexu-io/open-design/main/design-templates/docs-page/SKILL.md -o SKILL.md
Conteúdo técnico (SKILL.md)

Tradução do texto original do autor no GitHub. Os comandos e códigos estão como no original.

Página de Documentação da Skill

Produza uma única página de documentação com três colunas em um único arquivo HTML.

Fluxo de Trabalho

  1. Leia o DESIGN.md ativo (injetado acima). Use o token de tipo de corpo para prosa; o token mono para código; respeite as regras de altura da linha e largura máxima.
  2. Escolha um tópico do resumo — a página deve parecer documentação real, não um wireframe genérico. Nomes concretos de API, exemplos de comandos, parâmetros plausíveis.
  3. Disponha três regiões, expressas no eixo inline para que o layout inverta corretamente sob dir="rtl":
    • Navegação inline-início (240–280px, fixo): lista de links agrupados, página atual em negrito com uma faixa de destaque na borda inline-start. 3–5 grupos de 4–8 links.
    • Corpo do artigo (largura máxima ~720px, centralizado na coluna do meio): H1, parágrafo de introdução, seções H2, blocos de código, caixas de destaque (nota / aviso), links inline, listas.
    • Sumário inline-fim (200–240px, fixo): "Nesta página" com os âncoras H2/H3, seção atual destacada conforme o usuário rola.
  4. Escreva um único documento HTML:
    • <!doctype html> até </html>, todo o CSS inline.
    • CSS Grid para as três colunas; posicionamento fixo para os trilhos.
    • Blocos de código: token monoespaçado, preenchimento de superfície suave, indicação de botão de cópia (apenas visual — sem necessidade de JS).
    • IDs de âncora em todos os H2/H3 para que os links do sumário funcionem.
    • data-od-id na navegação, artigo e sumário.
  5. Prosa: escreva pelo menos 350 palavras de documentação crível. Inclua pelo menos um comando de shell, um trecho de código (5–15 linhas), uma chamada de atenção, uma tabela.
  6. Auto-verificação:
    • O texto do corpo quebra no ponto ideal de comprimento de linha do DS (60–75 caracteres).
    • O código usa o token mono do DS, não o genérico monospace.
    • O destaque é contido — usado para o item de navegação ativo, links, uma borda de chamada de atenção. Não no texto do corpo.
    • A página é legível em 1280px e colapsa graciosamente abaixo de 900px (o sumário sai, a navegação se torna uma gaveta superior).
    • Use CSS lógico (margin-inline-start, border-inline-start, inset-inline-end, text-align: start) nos trilhos e na faixa de destaque para que o layout inverta corretamente sob dir="rtl".

Contrato de Saída

Emita entre as tags <artifact>:

<artifact identifier="docs-slug" type="text/html" title="Docs — Page Title">
<!doctype html>
<html>...</html>
</artifact>

Uma frase antes do artefato, nada depois.

Perguntas frequentes

O que são 'tokens'?

Tokens são como blocos de construção pré-definidos que a ferramenta usa para formatar o texto e o código, garantindo consistência.

O que significa 'layout flips correctly under dir="rtl"'?

Isso significa que a página se adapta automaticamente para idiomas que são lidos da direita para a esquerda (como o árabe), invertendo a posição das colunas.

A página gerada precisa de JavaScript?

Não, o botão de cópia de código é apenas visual. A estrutura principal da página é feita com HTML e CSS.

Detalhes

Descrição original do autor

A documentation page — inline-start nav, scrollable article body, inline-end table of contents. Use when the brief mentions "docs", "documentation", "guide", "API reference", or "tutorial".

repo: nexu-io/open-design

Popularidade

Estrelas no GitHub
101 mil
Posição no ranking
#413
Licença
Apache-2.0
Atualizada em
16/10/2026

Essa skill é útil?

0

Entre para votar.

Comentários

  • …

Mais skills deste repositório

Skills parecidas