S Skillteca
Receber por email
Explorar Categorias Coleções Newsletter
← Voltar para o catálogo

writing-docs

Escrita e Conteúdo Autor: bg-szy

Expert at writing high-quality documentation for code, APIs, and projects. Auto-invokes when generating docstrings, creating README files, writing API documentation, adding code comments, or producing any technical documentation. Provides language-specific templates and best practices for effective documentation writing.

2estrelas
Atualizado há 4 meses
Ver no GitHub ↗

Como adicionar

/plugin marketplace add bg-szy/TOP-SKILLS

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/writing-docs-bg-szy/svg)](https://www.skillteca.com.br/skills/writing-docs-bg-szy)
#api

Skills relacionadas

Ver todas de Escrita e Conteúdo →

algorithmic-art

153.1k

Cria arte algorítmica original usando p5.js, aleatoriedade com semente e exploração interativa de parâmetros. Use para solicitações de arte generativa, campos de fluxo ou sistemas de partículas, garantindo a não violação de direitos autorais.

Escrita e Conteúdo por anthropics

doc-coauthoring

153.1k

Guia usuários por um fluxo de trabalho estruturado para coautoria de documentação, propostas, especificações técnicas e conteúdo similar. Ajuda a transferir contexto de forma eficiente, refinar o conteúdo por iteração e verificar sua eficácia para os leitores.

Escrita e Conteúdo por anthropics

copywriting-psychologist

41.2k

One sentence - what this skill does and when to invoke it

Escrita e Conteúdo #git #github por sickn33

documentation-generation-doc-generate

41.2k

Especialista em documentação que cria documentação abrangente e de fácil manutenção a partir do código, gerando documentação de API, diagramas de arquitetura, guias do usuário e referências técnicas usando análise impulsionada por IA e as melhores práticas da indústria.

Escrita e Conteúdo #ai #api por sickn33

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

Writing Documentation Skill

You are an expert at writing clear, comprehensive, and useful documentation for software projects.

When This Skill Activates

This skill auto-invokes when:

  • User asks to "document this function/class/module"
  • User wants to create or update a README
  • User needs JSDoc, docstrings, or code comments
  • User asks for API documentation
  • User wants documentation for a specific file or codebase

Documentation Writing Principles

Core Principles

  1. **Clarity

[Description truncada. Veja o README completo no GitHub.]

Compartilhar X LinkedIn