What does upstream and downstream mean in this context?

Upstream traces toward more abstract parent needs (like user requirements), while downstream traces toward concrete child needs (like implementation details or test cases).

What is a Sphinx-needs project?

A Sphinx-needs project uses the sphinx-needs extension to manage requirements, specifications, and tests as objects within Sphinx documentation, allowing for programmatic tracking of project needs.

Can it find links in actual source code?

Yes, if sphinx-codelinks is configured, the skill can trace links from documentation items directly to specific code symbols and files using grep-based pattern matching.

How does it handle circular links?

The skill includes a cycle detection algorithm that identifies and flags circular dependencies in the traceability tree to prevent infinite loops and highlight potential modeling errors.

Does it support custom link types?

Yes, it automatically detects and follows project-specific extra_links (like 'tests', 'verifies', or 'implements') defined in your project configuration.

Pharaoh Traceability Navigator

Name: Pharaoh Traceability Navigator
Author: patdhlk

bypatdhlk

•

Learning & Documentation

Navigates and visualizes complex traceability links between requirements, specifications, and code in Sphinx-needs projects.

Pharaoh Traceability Navigator is a specialized tool for engineers working with Sphinx-needs documentation to maintain rigorous project oversight. It allows users to traverse the entire lifecycle of a feature by tracing links upstream to high-level requirements or downstream to specific implementations and test cases. By building a comprehensive link graph, detecting circular dependencies, and highlighting traceability gaps based on project-specific rules, it ensures that project documentation remains consistent, compliant, and fully accounted for across the development lifecycle.

Key Features

01Automated traceability gap analysis using project-specific required_links

02Bi-directional link tracing (upstream/downstream) through all link types

03Automatic Sphinx-needs project structure and configuration detection

04Integration with sphinx-codelinks for direct code-to-requirement mapping

05Visual tree representation with cycle detection and status indicators

061 GitHub stars

Use Cases

01Verifying that a high-level requirement is fully covered by specifications, implementations, and tests.

02Auditing documentation for missing links or circular dependencies before a release or compliance audit.

03Performing impact analysis to see which downstream components are affected by a requirement change.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add patdhlk/pharaoh pharaoh-trace

For use in Claude.ai and ChatGPT

Download Skill