skills.rest
FelipePepe
FelipePepeCOMMUNITY
Explore all skills by this author →
GitHub

rule-docs

Enforce JSDoc/TSDoc comments and ADR updates in PRs.

Updated Jan 25, 2026
Search Tags:#documentation#adr#code-review#pull-request#architecture-decision#documentation-standards
One-click install
npx skills add https://github.com/FelipePepe/TeamHub --skill rule-docs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: rule-docs
Source: https://github.com/FelipePepe/TeamHub/tree/main/.agents/skills/rule-docs
Command: npx skills add https://github.com/FelipePepe/TeamHub --skill rule-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Imposes consistent documentation standards and ensures mandatory ADR/decisiones.md updates are performed after meaningful work (features, bug fixes, refactors, or architectural changes).

Core Features & Use Cases

  • Enforces JSDoc/TSDoc comments on functions and methods.
  • Requires updating decisiones.md as part of PRs for significant changes.
  • Keeps ADRs and documentation in sync, ensuring traceable decisions across PRs.

Quick Start

After starting a feature, bug fix, refactor, or architectural decision, trigger this skill to ensure ADRs and docs stay up to date.

Frequently Asked Questions about rule-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce documentation standards and ADR updates in pull requests?▼

To enforce documentation standards in pull requests, trigger this skill to mandate JSDoc/TSDoc comments and require ADR entries in docs/decisiones.md for features, bugs, and refactors. It ensures an auditable decision history within PRs.

What is an architecture decision record and when do I need to update it?▼

An architecture decision record (ADR) documents significant technical choices. You need to update ADRs in decisiones.md after meaningful work like feature additions, bug fixes, refactors, or architectural changes to maintain an auditable decision history.

How do I keep ADRs and code documentation in sync during a refactor?▼

Keep ADRs and code documentation in sync during a refactor by triggering this skill to enforce mandatory JSDoc/TSDoc comments and ensure decisiones.md is updated directly within the pull request workflow for full traceability.

Do I need JSDoc comments on all functions to pass PR documentation hygiene checks?▼

Yes, this skill enforces JSDoc and TSDoc comments on functions and methods to pass PR documentation hygiene checks. It ensures code documentation meets repository standards alongside mandatory ADR updates.

What's the best way to maintain an auditable decision history for architectural changes?▼

Maintain an auditable decision history for architectural changes by enforcing ADR updates in decisiones.md at the PR level. This skill ensures every architectural decision is recorded and traceable across the repository.

Related Skills

Explore More Content & Communication Skills→
icartshicartsh
4

markdown-pro

Generate READMEs, changelogs, and API references from Git history.

Community
Advanced
armanzeroeightarmanzeroeight
29

api-docs-generator

Generate API documentation from code into HTML or JSON formats.

Community
Intermediate
onejaejaeonejaejae
2

pr-review-handler

Automates sorting, responding to, and committing fixes for PR review comments.

Community
Advanced
masa-codehubmasa-codehub

analyzing-github-reviews

Classifies GitHub PR review comments into Accept, Discuss, or Explain with SSOT-aligned analysis.

Community
Advanced