review-notes

Generate structured WPS technical documentation with seven required sections.

Updated Apr 17, 2026
One-click install
npx skills add https://github.com/dy9759/SkillCollection --skill review-notes-dy9759
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: review-notes
Source: https://github.com/dy9759/SkillCollection/tree/main/skills/coding-assistant/review-notes
Command: npx skills add https://github.com/dy9759/SkillCollection --skill review-notes-dy9759

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Helps developers and reviewers turn code, comments, and design discussions into a consistent, saved WPS technical note so important architecture, core code, and implementation details are recorded and discoverable.

Core Features & Use Cases

  • Context-aware note creation: Detects the current file, selected code, or clipboard content and either updates an existing note that matches the class or directory name or creates a new one.
  • Seven-section technical template: Ensures notes include the required sections (核心技术 with diagram, 核心代码, 关键技术点, 核心类和职责, 调用链 as mermaid, 架构概览 with diagram, 注意事项) and inserts code blocks and diagrams as needed.
  • Diagram and code insertion: Generates or inserts architecture and call-chain diagrams (generate_image / mermaid) and writes core code blocks extracted from comments, selection, or specified functions.
  • Proactive syncing and edits: Synchronizes edits to WPS, supports batch edits, global replacements, and periodically refreshes the current note while it remains open.

Quick Start

Create or update a WPS technical note for the selected class, including the seven required sections and an architecture diagram.

Frequently Asked Questions about review-notes

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

FAQPage Schema
How do I generate WPS technical notes from code comments and selected functions?

Generate WPS technical notes by extracting code blocks, comments, and selected functions, then inserting them into a seven-section template with architecture diagrams and mermaid call chains. The Skill detects your current file or clipboard content to automatically create or update matching documentation.

Can I auto-generate mermaid call chain diagrams for code review documentation?

Auto-generate mermaid call chain diagrams for code review by extracting function calls and class relationships from your selected code. The Skill inserts these diagrams into the 调用链 section of your WPS technical note alongside architecture overview visualizations.

What sections are required in a structured technical note for code review?

Structured technical notes require seven sections: 核心技术 with diagram, 核心代码, 关键技术点, 核心类和职责, 调用链 as mermaid, 架构概览 with diagram, and 注意事项. The template ensures architecture, core code, and implementation details are consistently recorded.

Does this documentation generator work with Cursor and Claude Code editing workflows?

This documentation generator works with Cursor, Codex, and Claude Code by triggering during editing workflows. It detects the current file or selected code in your editor and synchronizes the generated technical notes directly to WPS.

How do I synchronize code edits to existing WPS technical notes?

Synchronize code edits to WPS technical notes by matching the current class or directory name to an existing note. The Skill supports batch edits, global replacements, and periodically refreshes the note while it remains open to keep documentation current.

What's the best way to document architecture overview with diagrams for selected code blocks?

Document architecture overviews by generating or inserting diagrams into the 架构概览 section of your WPS note. The Skill extracts code blocks from your selection or specified functions and automatically adds both architecture diagrams and mermaid call chains to the seven-section template.