tech-leads-club/docs-writer
packages/skills-catalog/skills/(development)/docs-writer/SKILL.md
Write, review, and edit documentation files with consistent structure, tone, and technical accuracy. Use when creating docs, reviewing markdown files, writing READMEs, updating `/docs` directories, or when user says "write documentation", "review this doc", "improve this README", "create a guide", or "edit markdown". Do NOT use for code comments, inline JSDoc, or API reference generation.
$ install --global
skillsauthnpx skillsauth add tech-leads-club/agent-skills docs-writerInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 15, 2026, 5:16 AM6.2s2 files scanned
SKILL.md
- name:
- docs-writer
- description:
- Write, review, and edit documentation files with consistent structure, tone, and technical accuracy. Use when creating docs, reviewing markdown files, writing READMEs, updating `/docs` directories, or when user says "write documentation", "review this doc", "improve this README", "create a guide", or "edit markdown". Do NOT use for code comments, inline JSDoc, or API reference generation.
docs-writer skill instructions
As an expert technical writer and editor, your goal is to produce and refine documentation that is accurate, clear, consistent, and easy for users to understand. You must adhere to the documentation contribution process outlined in CONTRIBUTING.md.
Step 1: Understand the goal and create a plan
- Clarify the request: Fully understand the user's documentation request. Identify the core feature, command, or concept that needs work.
- Differentiate the task: Determine if the request is primarily for writing new content or editing existing content. If the request is ambiguous (e.g., "fix the docs"), ask the user for clarification.
- Formulate a plan: Create a clear, step-by-step plan for the required changes.
Step 2: Investigate and gather information
- Read the code: Thoroughly examine the relevant codebase, primarily within the
packages/directory, to ensure your work is backed by the implementation and to identify any gaps. - Identify files: Locate the specific documentation files in the
docs/directory that need to be modified. Always read the latest version of a file before you begin work. - Check for connections: Consider related documentation. If you change a command's behavior, check for other pages that reference it. If you add a new page, check if
docs/sidebar.jsonneeds to be updated. Make sure all links are up to date.
Step 3: Write or edit the documentation
- Follow the style guide: Adhere to the rules in
references/style-guide.md. Read this file to understand the project's documentation standards. - Ensure the new documentation accurately reflects the features in the code.
- Use
replaceandwrite_file: Use file system tools to apply your planned changes. For small edits,replaceis preferred. For new files or large rewrites,write_fileis more appropriate.
Sub-step: Editing existing documentation (as clarified in Step 1)
- Gaps: Identify areas where the documentation is incomplete or no longer reflects existing code.
- Tone: Ensure the tone is active and engaging, not passive.
- Clarity: Correct awkward wording, spelling, and grammar. Rephrase sentences to make them easier for users to understand.
- Consistency: Check for consistent terminology and style across all edited documents.
Step 4: Verify and finalize
- Review your work: After making changes, re-read the files to ensure the documentation is well-formatted, and the content is correct based on existing code.
- Link verification: Verify the validity of all links in the new content. Verify the validity of existing links leading to the page with the new content or deleted content.
- Offer to run npm format: Once all changes are complete, offer to run the project's formatting script to ensure consistency by proposing the command:
npm run format
Related Skills
tech-leads-club/pr-review
tools
VerifiedTrustedCommunity
Reviews a GitHub pull request and posts inline comments plus one consolidated summary, adapting to any codebase by discovering the project's own test runner, requirement specs, and architecture conventions before running six specialized review agents in parallel. Stack-agnostic across language and framework; targets GitHub PRs via the gh CLI. Use when the user says "review PR 128", "review this PR", "code review this PR", or "check this pull request". Do NOT use for creating PRs or responding to review comments (use gh-address-comments), or debugging failing CI checks (use gh-fix-ci).
4,903SKILL.mdUpdated Jul 19, 2026
tech-leads-club/rails-dev
development
VerifiedTrustedCommunity
Opinionated Rails conventions: rich models, concerns, CRUD-everything, state-as-records, minimal dependencies, Minitest with fixtures. Load this skill BEFORE any code-level thinking, not only before editing a file. It is required the moment a task touches Rails code in ANY way: designing or even just discussing a data model, schema, migration, entity, association, field, validation, class, or method name; writing, planning, reviewing, analyzing, testing, debugging, or refactoring; or proposing any model, table, column, route, or code snippet inline in chat. If you are about to name a model or sketch a column you are already in scope, even in an exploratory back-and-forth where no file is written yet. Do not let a "we're just discussing" framing defer it. Do NOT use for non-Rails backends, NestJS, or general architecture (use nestjs-modular-monolith or coding-guidelines).
4,897SKILL.mdUpdated Jul 18, 2026
tech-leads-club/tlc-spec-driven
testing
VerifiedTrustedCommunity
Feature planning and implementation with 4 adaptive phases — Specify, Design, Tasks, Execute. Auto-sizes depth by complexity. Creates atomic tasks with verification criteria, atomic git commits, and requirement traceability. Features an independent Verifier (author != verifier, evidence-or-zero), persistent decision log (STATE.md), and test-coverage-matrix-driven tests, plus a self-improving lessons layer that turns verification failures into reusable project-local guidance. Stack-agnostic. Use when (1) Planning features (requirements, design, task breakdown), (2) Implementing with verification and atomic commits, (3) Validating or verifying an implementation against a spec. Triggers on "specify feature", "discuss feature", "design", "tasks", "implement", "validate", "verify work", "UAT", "record decision", "pause work", "resume work". Do NOT use for architecture decomposition analysis (use architecture skills) or technical design docs (use create-technical-design-doc).
4,840SKILL.mdUpdated Apr 27, 2026
tech-leads-club/tlc-generative-engine-optimization
development
VerifiedTrustedCommunity
Generative Engine Optimization (GEO) specialist — the technical, on-page publishing work that makes a given page or site discoverable, understandable, trustworthy, quotable, and fresh for AI answer engines (Google AI Overviews, ChatGPT Search, Bing Copilot, Perplexity). Use when asked to 'optimize this page/site for GEO', 'optimize for AI search / answer engines', 'get my page cited by ChatGPT/Perplexity', 'improve AI visibility/citability', 'write an llms.txt', 'add citation-ready structure or schema for AI answers', 'otimizar para busca com IA', or to audit/create/improve a codebase for generative search. Do NOT use for AI-driven SEO content strategy or programmatic pages at scale (use ai-seo), classic keyword/SERP ranking (use seo), accessibility (use web-accessibility), or multi-area site audits (use web-quality-audit).
4,816SKILL.mdUpdated Jul 5, 2026