Can I link to external resources like Jira or Wikis?

Yes, the skill includes specialized patterns for cross-referencing external issues, pull requests, Confluence pages, and official RFC specifications.

Does it support line-specific linking in source code?

Absolutely. It includes formats for linking to specific line ranges in source files, which is ideal for documenting specific implementations within larger classes or modules.

Is this compatible with existing tools like TypeDoc or OpenAPI?

Yes, the skill provides specific integration examples for common tools like JSDoc, TypeDoc, and Swagger/OpenAPI definitions to ensure a unified documentation strategy.

How does this skill help prevent documentation rot?

It provides standardized patterns and scripts for automated validation and pre-commit hooks that check for broken links, ensuring documentation remains accurate as the codebase evolves.

What is bidirectional documentation linking?

It is a development practice where code points to its documentation (via comments) and documentation points back to specific code files or lines, creating a navigable web of information that stays in sync.

Documentation Linking & Sync

Name: Documentation Linking & Sync
Author: TheBushidoCollective

byTheBushidoCollective

•

学习与文档

Establishes bidirectional links between source code and documentation to preserve architectural context and maintain artifact synchronization.

This skill empowers developers to maintain a 'living' documentation ecosystem by establishing robust, bidirectional links between code implementations and their corresponding documentation, including ADRs, API specs, and runbooks. By formalizing link patterns and providing automated validation strategies, it prevents documentation rot and ensures that critical context—such as architectural decisions, test data requirements, and monitoring alerts—is always easily accessible from the relevant code block. It is particularly useful for complex projects where maintaining the 'why' behind the 'what' is essential for long-term maintenance and team collaboration.

主要功能

01Bidirectional linking between source code comments and Markdown documentation

02Integration patterns for OpenAPI, TypeDoc, and repository-wide README files

0397 GitHub stars

04Standardized link formats for absolute, relative, line-specific, and anchor-based references

05Automated link validation scripts to detect and repair broken documentation references

06Templates for Architecture Docs, API Specs, Decision Records (ADRs), and Runbooks

使用场景

01Mapping database migration scripts to system-wide schema documentation and failover runbooks

02Linking complex business logic to Architectural Decision Records (ADRs) to preserve implementation rationale

03Connecting REST endpoints in code directly to their OpenAPI specifications and usage examples

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add thebushidocollective/han documentation-linking

For use in Claude.ai and ChatGPT

Download Skill