المهارات writing-docs
📦

writing-docs

آمن

Gerar Documentação Profissional com Melhores Práticas

Escrever documentação clara é desafiador e demorado. Esta skill gera automaticamente documentação abrangente usando templates específicos para cada linguagem e melhores práticas da indústria, garantindo que seu código seja bem documentado e mantível.

يدعم: Claude Codex Code(CC)
📊 70 كافٍ
1

تنزيل ZIP المهارة

2

رفع في Claude

اذهب إلى Settings → Capabilities → Skills → Upload skill

3

فعّل وابدأ الاستخدام

اختبرها

استخدام "writing-docs". Documente esta função: function calculateDiscount(price, percentage) { return price * (1 - percentage / 100); }

النتيجة المتوقعة:

/**
* Calculates the discounted price by applying a percentage discount.
*
* @param {number} price - The original price before discount
* @param {number} percentage - The discount percentage (0-100)
* @returns {number} The final price after applying the discount
*
* @example
* // Calculate 20% off $100
* const finalPrice = calculateDiscount(100, 20);
* // Returns: 80
*
* @example
* // Calculate 15% off $50.99
* const finalPrice = calculateDiscount(50.99, 15);
* // Returns: 43.3415
*/

استخدام "writing-docs". Crie um README para uma biblioteca wrapper de API de clima

النتيجة المتوقعة:

  • # Weather API Wrapper
  • A simple, lightweight JavaScript wrapper for popular weather APIs with built-in caching and error handling.
  •  
  • ## Features
  • - Support for multiple weather providers (OpenWeather, WeatherAPI)
  • - Built-in response caching to reduce API calls
  • - TypeScript support with full type definitions
  • - Promise-based async API with error handling
  •  
  • ## Installation
  • ```bash
  • npm install weather-api-wrapper
  • ```
  •  
  • ## Quick Start
  • ```javascript
  • import WeatherAPI from 'weather-api-wrapper';
  •  
  • const weather = new WeatherAPI({ apiKey: 'your-key' });
  • const forecast = await weather.getForecast('London');
  • console.log(forecast.temperature);
  • ```

التدقيق الأمني

آمن
v6 • 1/21/2026

This skill is completely safe. Static analysis flagged 89 patterns, but all are false positives from markdown documentation examples. The skill contains only documentation templates and guidelines with no executable code, network requests, or command execution. All detected patterns are markdown formatting (code fences, backticks) and example placeholder URLs in documentation templates.

2
الملفات التي تم فحصها
1,275
الأسطر التي تم تحليلها
0
النتائج
6
إجمالي عمليات التدقيق
لا توجد مشكلات أمنية
تم تدقيقه بواسطة: claude عرض سجل التدقيق →

درجة الجودة

38
الهندسة المعمارية
100
قابلية الصيانة
87
المحتوى
21
المجتمع
100
الأمان
91
الامتثال للمواصفات

ماذا يمكنك بناءه

Documentar Novos Endpoints de API

Desenvolvedores de software podem usar esta skill para gerar rapidamente documentação abrangente de API para novos endpoints, incluindo descrições de parâmetros, formatos de resposta, códigos de erro e exemplos de uso.

Adicionar Docstrings Faltantes a Código Legado

Equipes de engenharia mantendo bases de código legadas podem adicionar sistematicamente docstrings adequadas a funções e classes não documentadas, melhorando a manutenibilidade do código e a integração de novos membros da equipe.

Criar Arquivos README de Projetos

Mantenedores de código aberto e proprietários de projetos podem gerar arquivos README profissionais com estrutura adequada, incluindo recursos, instruções de instalação, exemplos de uso e diretrizes de contribuição.

جرّب هذه الموجهات

Gerar Docstring de Função
Documente esta função com uma descrição clara, tipos de parâmetros, valor de retorno e um exemplo de uso
Criar README do Projeto
Crie um README abrangente para este projeto incluindo instruções de instalação, lista de recursos, exemplos de uso e referência de API
Adicionar JSDoc ao Módulo
Adicione comentários JSDoc a todas as funções públicas neste módulo com descrições de parâmetros, tipos de retorno e exemplos para cada uma
Documentar Endpoints de API
Gere documentação de API para estes endpoints incluindo parâmetros de requisição, schema de resposta, códigos de status e exemplos curl

أفضل الممارسات

  • Sempre inclua pelo menos um exemplo de código funcional na documentação de funções. Exemplos ajudam desenvolvedores a entender o uso mais rápido do que apenas descrições.
  • Documente todos os parâmetros com seus tipos e se são opcionais. Inclua valores padrão quando aplicável para prevenir confusão.
  • Escreva a primeira linha como um resumo claro e conciso que possa ser independente. Muitas ferramentas de documentação exibem apenas a primeira linha em visões gerais e resultados de busca.

تجنب

  • Não escreva documentação que simplesmente repete o nome da função. Documentação como 'getName() obtém o nome' não fornece valor aos desenvolvedores.
  • Evite documentar detalhes de implementação que podem mudar. Foque na interface pública, comportamento e contrato ao invés de mecânicas internas.
  • Não deixe código de exemplo não testado ou desatualizado. Exemplos quebrados na documentação são piores do que nenhum exemplo e prejudicam a confiança dos desenvolvedores.

الأسئلة المتكررة

Quais formatos de documentação esta skill suporta?
A skill suporta JSDoc para JavaScript e TypeScript, docstrings no estilo Google para Python, formatos de comentário padrão para Go e Rust, e Markdown para arquivos README e documentação geral. Ela fornece templates específicos para cada formato de linguagem.
Esta skill pode gerar documentação automaticamente analisando meu código?
Não, esta skill fornece templates e melhores práticas para escrever documentação, mas não infere automaticamente o comportamento da função a partir da análise de código. Você precisa fornecer informações sobre o que o código faz, e a skill irá formatá-las adequadamente.
Como personalizo o estilo de documentação para meu projeto?
A skill fornece templates padrão como pontos de partida. Você pode solicitar modificações para corresponder ao guia de estilo do seu projeto, como alterar o formato de docstring, adicionar seções customizadas ou ajustar o nível de detalhe nos exemplos.
Isso funciona com ferramentas de geração de documentação como JSDoc ou Sphinx?
Sim, os formatos de documentação gerados por esta skill são compatíveis com ferramentas populares de documentação. Comentários JSDoc funcionam com JSDoc, TypeDoc e ferramentas similares. Docstrings Python funcionam com Sphinx, pdoc e outros geradores de documentação Python.
Esta skill pode atualizar documentação existente ao invés de criar documentação nova?
Sim, você pode pedir à skill para revisar e melhorar documentação existente. Ela pode adicionar seções faltantes, melhorar clareza, adicionar exemplos ou reformatar documentação para seguir melhores práticas enquanto preserva seu conteúdo original.
Qual é a diferença entre esta skill e apenas pedir ao Claude Code para escrever documentação?
Esta skill fornece templates especializados, formatação específica por linguagem e melhores práticas estruturadas para documentação. Ela garante consistência, segue padrões da indústria e inclui seções abrangentes como parâmetros, retornos, erros e exemplos que podem ser esquecidos em solicitações gerais.

تفاصيل المطور

بنية الملفات

📄 SKILL.md