documentation-linking

Bidirectional linking establishes synchronized references between code and docs by annotating code blocks with documentation pointers and adding code references within documentation. This maintains traceability across architecture docs, API specs, decision records, tests, and runbooks using anchor, relative, and line-specific link formats.

Documentation can reference code using absolute paths, relative paths, line-specific links that point to exact lines in source files, and anchor-based links tied to annotated blocks. These formats enable precise cross-references while adapting to different documentation structures and repository layouts.

Yes. Code annotations and comments can link directly to documentation artifacts—including architecture docs, API specifications, decision records, and runbooks—creating Code → Documentation references that point readers from implementation details to relevant external resources.

Bidirectional linking preserves context and traceability through annotated blocks, inline comments, and metadata that synchronize artifacts. This enforcement of cross-reference rules ensures that when code or documentation changes, the relationship between them remains intact and traceable.

Code can link to architecture documentation, API specifications, decision records, tests, and runbooks. The Skill supports linking across these documentation types using defined link formats, enabling comprehensive traceability from implementation through design decisions and operational guidance.

The Skill enforces cross-reference rules and metadata synchronization to help maintain link integrity. However, link maintenance depends on your documentation and version control workflow; the Skill establishes the linking structure and traceability mechanism, not automatic updates.