weapp-doc-sync

Synchronize WeChat mini program docs, APIs, tests, and code with a consistency report.

1|Updated Mar 11, 2026
One-click install
npx skills add https://github.com/hekinami/weapp-dev-workflow --skill weapp-doc-sync
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: weapp-doc-sync
Source: https://github.com/hekinami/weapp-dev-workflow/tree/main/skills/weapp-doc-sync
Command: npx skills add https://github.com/hekinami/weapp-dev-workflow --skill weapp-doc-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

这个技能解决微信小程序全栈项目中“文档、设计、测试和代码彼此不一致”的问题,帮助团队在需求变更、接口调整或模型修改后快速找出差异并完成同步。

Core Features & Use Cases

  • 一致性检查:对架构文档、User Story、类图、OpenAPI、测试代码和前后端实现做交叉校验。
  • 变更同步:在类图、API、需求或架构发生变化时,更新受影响的相关产物并尽量保持最小改动。
  • 同步报告:输出已检查项、发现问题、已执行修复和待人工确认事项,方便回溯与协作。
  • Use Case:当后端接口字段变更后,可用该技能联动检查前端调用、测试覆盖和数据模型是否仍然一致。

Quick Start

Use the weapp-doc-sync skill to review the latest architecture, API, tests, and backend/frontend code and return a synchronization report with any inconsistencies.

Frequently Asked Questions about weapp-doc-sync

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

FAQPage Schema
How do I keep WeChat mini program architecture documents and code in sync after API changes?

Synchronize WeChat mini program architecture documents and code by cross-checking OpenAPI specs, user stories, class diagrams, tests, and frontend/backend implementations to identify inconsistencies. The process validates schema-to-API mapping, endpoint implementation, and request-response alignment, then produces a synchronization report detailing checked items, issues, and fixes.

What is documentation synchronization for WeChat mini program development workflows?

Documentation synchronization is the process of validating cross-document traceability across architecture docs, user stories, database class diagrams, OpenAPI specs, tests, and application code. It eliminates inconsistencies caused by requirements changes, API updates, or model adjustments by applying minimal modifications to affected artifacts and generating a synchronization report for team collaboration.

Can I validate OpenAPI schema-to-API mapping and endpoint implementation for mini program projects?

Yes, you can validate OpenAPI schema-to-API mapping by checking endpoint implementation, response and request alignment, and cross-document traceability. This confirms that backend interface field changes correctly propagate to frontend calls, test coverage, and data models, ensuring full-stack consistency across the WeChat mini program project.

How to check test coverage and data model consistency when backend interface fields change?

Check test coverage and data model consistency by running a cross-validation of architecture documents, OpenAPI specs, tests, and frontend/backend code. This identifies mismatches between updated backend interface fields and existing tests or data models, applies minimal modifications to affected artifacts, and outputs a synchronization report with pending manual review items.

What's the best way to handle reverse engineering maintenance for WeChat mini program documentation?

Handle reverse engineering maintenance by synchronizing existing architecture documents, user stories, class diagrams, OpenAPI specs, and tests with the current application code. This approach validates schema-to-API mapping and cross-document traceability, updates affected artifacts with minimal changes, and generates a synchronization report for tracking completed fixes and pending confirmations.

Does documentation sync work with mermaid class diagrams and OpenAPI specs together?

Yes, documentation sync cross-checks mermaid database class diagrams alongside OpenAPI specs, user stories, tests, and application code. It validates schema-to-API mapping and cross-document traceability, identifies inconsistencies when models or APIs change, applies minimal modifications, and produces a synchronization report covering checked items, discovered issues, and executed fixes.