Skip to content

feat(pm-team): add deep-doc-review skill (adapted from optimus)#332

Open
gandalf-at-lerian wants to merge 1 commit intomainfrom
feat/deep-doc-review
Open

feat(pm-team): add deep-doc-review skill (adapted from optimus)#332
gandalf-at-lerian wants to merge 1 commit intomainfrom
feat/deep-doc-review

Conversation

@gandalf-at-lerian
Copy link
Copy Markdown
Contributor

Summary

Adds ring:deep-doc-review to the pm-team plugin.

Cross-references project docs (PRD, TRD, API design, data model) to find errors, inconsistencies, gaps, and contradictions BEFORE implementation starts. Works as a pre-gate before entering dev-cycle.

Key features

  • Auto-discovers project documentation
  • Cross-references information between docs (not just single-doc review)
  • Severity classification: CRITICAL/HIGH/MEDIUM/LOW
  • Interactive finding-by-finding resolution with user approval
  • Ring-native frontmatter and conventions

Origin

Adapted from alexgarzao/optimus (optimus-deep-doc-review), converted to Ring format.

cc @alexgarzao

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 9, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 080f7ba4-f0e7-4ef9-ba8b-e4e1a946eb62

📥 Commits

Reviewing files that changed from the base of the PR and between 9011f82 and ce4b712.

📒 Files selected for processing (1)
  • pm-team/skills/deep-doc-review/SKILL.md

Walkthrough

A new skill definition file introduces ring:deep-doc-review, a documentation review workflow that executes as a pre-gate before the development cycle. It defines trigger rules, multi-phase analysis workflow, issue taxonomy with severity levels, cross-reference requirements, interactive resolution flow, and final summary reporting.

Changes

Cohort / File(s) Summary
Deep Doc Review Skill
pm-team/skills/deep-doc-review/SKILL.md
New skill definition introducing a documentation pre-gate workflow with multi-phase review (discover, analyze, present, resolve, summarize), explicit issue/severity taxonomy, cross-reference matrix for document relationships, interactive user-driven resolution per finding, and final statistics reporting.

Sequence Diagram(s)

sequenceDiagram
    actor User
    participant Workflow as Deep Doc Review<br/>Workflow
    participant Docs as Documentation<br/>Files
    participant Analyzer as Analysis<br/>Engine
    participant UI as Review<br/>Interface
    participant Approver as Approval<br/>Gate

    User->>Workflow: Trigger (based on skip/trigger rules)
    Workflow->>Docs: Discover & Load Documents
    Docs-->>Analyzer: Document Content
    Analyzer->>Analyzer: Analyze with Cross-referencing<br/>(PRD, TRD, API, Data Model, etc.)
    Analyzer-->>UI: Findings with Issues & Severity
    UI->>UI: Present Overview Table
    UI-->>User: Display Findings
    loop For Each Finding
        User->>UI: Decide: Fix/Adjust/Skip
        UI->>User: Confirm Resolution
    end
    User->>Approver: Request Approval
    Approver-->>User: Approval Decision
    alt Approved
        Workflow->>Docs: Apply Corrections
        Docs-->>Workflow: Updates Complete
    else Denied
        Workflow->>User: Review Changes Required
    end
    Workflow->>UI: Generate Final Summary<br/>(Fixed/Skipped Statistics)
    UI-->>User: Report Complete
Loading

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants