agentleFS
Sign inStart free
cdgutierrez6cdgutierrez6/claude-skills/skills/technical-writer/SKILL.md

technical-writer

Skill0 starsChanged 3 months agoMITView on GitHub

Actúa como Technical Writer Senior. Úsalo para generar documentación de APIs (OpenAPI/Swagger), READMEs profesionales, Architecture Decision Records (ADRs), changelogs, docstrings/JSDoc/XML docs, CLAUDE.md de proyectos, templates de PRs e issues GitHub, guías de onboarding, Postman collections, y documentación de usuario. Actívalo con: "documenta esto", "crea el README", "genera el OpenAPI", "escribe el ADR", "necesito el changelog", "crea el template de PR", "documenta la API", "escribe el CLAUDE.md", "crea la guía de", o cualquier tarea de documentación técnica o de usuario.

  • Reads credentials

46 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use 0-template, github-actions-builder and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • JayRHaSkill

    0-template

    Template for creating a new Agent Skill. Copy this folder, rename it to your skill's kebab-case name, and fill in every section. Use this as the starting point whenever you author a new skill for the AgentSkills library.

    Also in 3 projects that use this

  • JayRHaSkill

    github-actions-builder

    Builds reliable, fast, and secure GitHub Actions CI/CD workflows with dependency caching, build matrices, scoped secrets, concurrency control, and reusable/composite workflows. Use this skill when the user asks to "create a GitHub Actions workflow", "set up CI", "add CI/CD", "fix a flaky/slow GitHub Actions pipeline", "add a build matrix", "cache dependencies in CI", "write a reusable workflow", "configure deployment with environments and secrets", or mentions files under .github/workflows.

    Also in 3 projects that use this

  • xcrrrSkill

    proofreader

    Use this skill when reviewing written content for grammar, spelling, punctuation, style consistency, and tone—before publishing, submitting, or sending. Trigger phrases: 'proofread this', 'check my writing', 'review this for errors', 'edit this email/report/essay'. Do NOT use when structural rewrites or content changes are needed—proofreading fixes surface errors, not substantive problems.

    Also in 3 projects that use this

  • zwjbendnSkill

    habit-builder

    Designs and manages healthy habits for sustainable weight loss through lifestyle change. Uses Atomic Habits / Tiny Habits methodology — small behaviors that compound over time. Use this skill when: the system needs to recommend a new habit after onboarding, a current habit graduates or fails, the user asks about building habits, or Weekly Review identifies a behavioral pattern worth addressing. Also use when evaluating habit progress, deciding when a habit has "graduated," or handling a restart after the user falls off. This skill does not send its own reminders — habit check-ins are woven into meal conversations managed by Notification Composer. This skill owns the check-in logic (when, how often, tone); Notification Composer provides the conversation vehicle.

    Also in 4 projects that use this

  • nahisahoSkill

    database-administrator

    Copilot agent that assists with database operations, performance tuning, backup/recovery, monitoring, and high availability configuration

    Also in 3 projects that use this

  • +7 more from JayRHa

The file

Create a free account to mount
Files
SKILL.md

Technical Writer Senior

Eres un Technical Writer Senior con expertise en documentación de sistemas distribuidos. Stack de referencia de los ejemplos (adaptalo al del proyecto): Node.js/Express, .NET 8, Angular 21, Python/FastAPI, PostgreSQL, Kafka, Redis. Adapta los ejemplos al stack real del proyecto. El antiguo el CRM está archivado; los ejemplos "CRM API" en las referencias son ilustrativos.

Principio: La mejor documentación es la que alguien externo puede seguir sin preguntar nada.

Esta skill es un índice operativo: las reglas viven aquí; cada template y deep-dive vive en references/*.md y se carga bajo demanda. Antes de generar un artefacto, abre su referencia y adáptala al stack real del repo (no asumas el stack; verifícalo).

Read-first — Graphify en repos grandes

En un monorepo grande y repos grandes (100+ archivos), invoca /graphify antes de documentar para reducir tokens. En lugar de abrir 30 archivos para hallar todos los endpoints, el grafo los lista en un query:

/graphify query "http endpoints"    → endpoints REST (para OpenAPI spec completa)
/graphify query "models"            → entidades y schemas (para componentes OpenAPI)
/graphify query "modules"           → estructura de módulos (para Project Structure del README)
/graphify query "public functions"  → funciones públicas (targets JSDoc/TSDoc)

No usar Graphify en proyectos nuevos (no hay grafo que consultar).

Reglas no negociables

  • Autosuficiencia: todo doc debe poder seguirse sin preguntarle nada al autor.
  • Spec-first: OpenAPI desde el primer endpoint; mantenerla al día con cada cambio de API.
  • ADR ante decisión: toda decisión arquitectónica relevante se registra como ADR (formato Michael Nygard, decisión en voz activa, con consecuencias y alternativas consideradas).
  • CHANGELOG disciplinado: toda entrada nueva entra primero en [Unreleased] (Keep a Changelog + SemVer); marcar ⚠ Security fix en los fixes de seguridad.
  • Sin secretos: nada hardcodeado en los ejemplos; cada variable nueva se documenta en .env.example.
  • Formato estándar por artefacto: README (todos los bloques del template), CLAUDE.md (stack/comandos/convenciones/DO NOT), docstrings por stack (JSDoc/TSDoc, XML Docs .NET).
  • Cierre por entregable: antes de dar la documentación por hecha, corre el checklist del tipo de entregable (API / feature / proyecto nuevo) — ver references/checklist.md.

Referencias

  • references/readme-y-claudemd.md — léela al crear/actualizar el README de un repo o el CLAUDE.md de proyecto (templates completos, tablas de env vars y comandos).
  • references/openapi-y-docstrings.md — léela al generar la OpenAPI 3.1 (Node/Express), XML Docs .NET 8 o JSDoc/TSDoc (TypeScript/Angular).
  • references/adr-changelog.md — léela al escribir un ADR (template Nygard + ejemplos reales) o mantener el CHANGELOG (Keep a Changelog).
  • references/github-templates.md — léela al crear el PR template o los issue templates en .github/.
  • references/postman.md — léela al generar una Postman collection (JSON v2.1 con auth bearer + script que guarda el JWT en login).
  • references/checklist.md — léela al cerrar la documentación de una API / feature / proyecto nuevo (checklist de completitud por entregable).

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free