Skip to content
All Skills

Quill

Adding JSDoc/TSDoc, updating READMEs, replacing any types with proper definitions, and adding high-value comments to complex logic. Use when documentation gaps, unclear intent, or type safety improvements are needed.

Software Engineering|v1|Updated 7/2/2026|GitHub source
MCP get_skill({ skillId: "quill-01fda678" })

Use this skill with your agent

Create a free account and connect via MCP

Get Started Free
<!--
CAPABILITIES_SUMMARY:
- jsdoc_tsdoc_documentation: Add JSDoc/TSDoc to public APIs, functions, interfaces with @param, @returns, @throws, @example tags following TSDoc standard (@microsoft/tsdoc parser)
- readme_management: Create, update, audit README.md with installation, usage, configuration, contributing sections
- type_definition_improvement: Replace `any` types with proper interfaces, generics, utility types, type guards, branded types, and `satisfies` — target ≥80% type coverage for public APIs. TS 5.4+ `NoInfer<T>` prevents inference widening at call sites. In TS6.0+ (strict-by-default), focus on fixing compiler-surfaced anys
- documentation_coverage_audit: Measure and report JSDoc coverage (≥80% public API target, ≥70% CI gate), type coverage, link health, example coverage
- api_documentation: OpenAPI/Swagger annotations, TypeDoc 0.28+ generation (including @expand/@inline/@disableGroups tags for type rendering control, @preventExpand/@preventInline overrides, basePath/displayBasePath for link resolution; 0.28 is ESM-only and requires TypeScript ≥5.0), API Extractor for monorepos (bundles TypeScript 5.7+ as of Jan 2025), GraphQL schema documentation
- complex_code_commenting: Explain magic numbers, complex regex, business rules, non-obvious constraints — mandatory when cyclomatic complexity >10
- changelog_maintenance: Keep a Changelog format, version tracking, deprecation notices
- documentation_quality_checklist: Completeness, accuracy, readability, maintainability verification
- documentation_rot_detection: Detect doc-code drift by comparing doc and code modification dates, CI-integrated freshness checks via Vale and link checkers, executable "Docs as Tests" validation for procedural docs, drift prevention
- documentation_effectiveness_calibration: Documentation pattern tracking, rot rate measurement, coverage trend analysis

COLLABORATION_PATTERNS:
- Pattern A: Code-to-Docs (Zen → Quill)
- Pattern B: Schema-to-Docs (Gateway → Quill)
- Pattern C: Architecture-to-Docs (Atlas → Quill)
- Pattern D: Design-to-Docs (Architect → Quill)
- Pattern E: Docs-to-Diagram (Quill → Canvas)
- Pattern F: Documentation Learning (Quill → Lore)
- Pattern G: CI Doc Gates (Gear → Quill → Gear)
- Pattern H: Migration Docs (Shift → Quill)

BIDIRECTIONAL_PARTNERS:
  INPUT:
    - Zen (refactored code needing docs)
    - Gateway (API specs to document)
    - Atlas (ADRs to link)
    - Architect (new agent SKILL.md)
    - Builder (new features needing docs)
    - Scribe (specification documents to reference)
    - Shift (deprecated API migration guides — Shift `detect`/`modernize`/`deprecate`)
    - Gear (CI documentation gate failures)
  OUTPUT:
    - Canvas (diagram requests)
    - Atlas (ADR requests)
    - Gateway (OpenAPI annotation updates)
    - Lore (validated documentation patterns)
    - Gear (documentation coverage CI gate config)

PROJECT_AFFINITY: Library(H) API(H) SaaS(M) CLI(M) Dashboard(M) Monorepo(M)
-->

# Quill

Codebase documentation steward. Add or repair JSDoc/TSDoc, README content, API docs, type clarity, and high-value comments without changing runtime behavior.

## Trigger Guidance

Use Quill when the user needs:

Continue reading

Sign up for a free account to view the full skill content

Login / Register
#broad-capability#development#security#devops#design#compliance#testing#documentationgitnodejsfilesystem-accesstypedocapi-extractor
Quill - AgentArmory Skill — AgentArmory