@ohos-cpf/3rdloop 0.0.1 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +245 -425
- package/bin/3rdloop.mjs +46 -46
- package/lib/cli.js +781 -740
- package/lib/config-cmd.js +452 -0
- package/lib/config.js +318 -317
- package/lib/doctor.js +113 -113
- package/lib/exit-codes.js +30 -30
- package/lib/opencode.js +155 -155
- package/lib/orch.js +426 -426
- package/lib/queries.js +263 -263
- package/lib/step.js +325 -325
- package/lib/ui.js +222 -222
- package/lib/update.js +280 -0
- package/lib/workflow.js +308 -290
- package/lib/workflows.js +131 -131
- package/package.json +50 -50
- package/vendor/Server/Agent/SkillSelector/README.md +343 -343
- package/vendor/Server/Agent/SkillSelector/core/Agent.js +207 -207
- package/vendor/Server/Agent/SkillSelector/index.js +14 -14
- package/vendor/Server/Agent/SkillSelector/llm/llmClient.js +313 -313
- package/vendor/Server/Agent/SkillSelector/llm/prompts.js +161 -161
- package/vendor/Server/Agent/SkillSelector/llm/reactSteps.js +144 -144
- package/vendor/Server/Agent/SkillSelector/matcher/fuzzyMatcher.js +433 -433
- package/vendor/Server/Agent/SkillSelector/scanner/skillScanner.js +382 -382
- package/vendor/Server/Agent/SkillSelector/utils/actionWords.js +59 -59
- package/vendor/Server/Brain/AnalysisStrategies.js +422 -422
- package/vendor/Server/Brain/Brain.js +686 -686
- package/vendor/Server/Brain/DecompositionStrategies.js +621 -621
- package/vendor/Server/Brain/PlanPersistence.js +196 -196
- package/vendor/Server/Brain/SkillExecutor.js +251 -251
- package/vendor/Server/Brain/index.js +11 -11
- package/vendor/Server/CLI/cli.js +275 -243
- package/vendor/Server/CLI/deveco-code/index.js +71 -0
- package/vendor/Server/CLI/deveco-code.js +5 -0
- package/vendor/Server/CLI/opencode/index.js +817 -804
- package/vendor/Server/CLI/opencode.js +5 -5
- package/vendor/Server/DbUse/MessageArchive.js +61 -61
- package/vendor/Server/DbUse/StorageManager.js +107 -107
- package/vendor/Server/DbUse/adapters/BaseAdapter.js +94 -94
- package/vendor/Server/DbUse/adapters/FileAdapter.js +138 -138
- package/vendor/Server/DbUse/adapters/JsonAdapter.js +138 -138
- package/vendor/Server/DbUse/adapters/JsonlAdapter.js +114 -114
- package/vendor/Server/DbUse/adapters/SqliteAdapter.js +157 -157
- package/vendor/Server/DbUse/index.js +160 -160
- package/vendor/Server/DbUse/stores/SessionStore.js +279 -279
- package/vendor/Server/DbUse/stores/TaskExecutionStore.js +133 -133
- package/vendor/Server/DbUse/stores/TaskRegistryStore.js +262 -262
- package/vendor/Server/DbUse/stores/TaskStepStore.js +279 -279
- package/vendor/Server/FlexRunner/FlexRunner.js +1759 -1759
- package/vendor/Server/FlexRunner/index.js +12 -12
- package/vendor/Server/Knowledge/KnowledgeImporter.js +523 -523
- package/vendor/Server/Knowledge/KnowledgeManager.js +341 -341
- package/vendor/Server/Knowledge/index.js +33 -33
- package/vendor/Server/LoopEngine/LoopEngine.js +1133 -1133
- package/vendor/Server/LoopEngine/index.js +11 -11
- package/vendor/Server/Orchestrator/Orchestrator.js +0 -3
- package/vendor/Server/Orchestrator/StepNode.js +312 -312
- package/vendor/Server/Orchestrator/index.js +13 -13
- package/vendor/Server/Routes/controllers/BrainController.js +241 -241
- package/vendor/Server/Routes/controllers/FlexRunnerController.js +1125 -1125
- package/vendor/Server/Routes/controllers/HealthController.js +44 -44
- package/vendor/Server/Routes/controllers/KnowledgeImportController.js +355 -355
- package/vendor/Server/Routes/controllers/LoopEngineController.js +788 -788
- package/vendor/Server/Routes/controllers/StatsController.js +57 -57
- package/vendor/Server/Routes/controllers/StreamController.js +67 -67
- package/vendor/Server/Routes/library/logger.js +179 -179
- package/vendor/Server/Routes/library/zipArchive.js +172 -172
- package/vendor/Server/Routes/router/Router.js +204 -204
- package/vendor/Server/Routes/routes/brain.js +47 -47
- package/vendor/Server/Routes/routes/flexrunner.js +72 -72
- package/vendor/Server/Routes/routes/health.js +28 -28
- package/vendor/Server/Routes/routes/index.js +57 -57
- package/vendor/Server/Routes/routes/knowledge.js +55 -55
- package/vendor/Server/Routes/routes/loopengine.js +58 -58
- package/vendor/Server/Routes/routes/orchestrator.js +61 -61
- package/vendor/Server/Routes/routes/registry.js +97 -97
- package/vendor/Server/Routes/routes/stats.js +23 -23
- package/vendor/Server/Routes/routes/stream.js +30 -30
- package/vendor/Server/Routes/server.js +203 -202
- package/vendor/Server/Routes/sse/SseHub.js +308 -308
- package/vendor/Server/Skills/acceptance-check/SKILL.md +191 -174
- package/vendor/Server/Skills/acceptance-check/references/PHASE1_ARTIFACT_COLLECTION.md +52 -52
- package/vendor/Server/Skills/acceptance-check/references/PHASE2_CRITERIA_EVALUATION.md +77 -77
- package/vendor/Server/Skills/acceptance-check/references/PHASE2_EVIDENCE_VERIFICATION.md +70 -0
- package/vendor/Server/Skills/arkts-code-check/SKILL.md +320 -313
- package/vendor/Server/Skills/arkts-code-check/references/CODE_CHECK_GUIDE.md +210 -159
- package/vendor/Server/Skills/arkts-code-check/references/FILE_TYPE_GUIDE.md +28 -28
- package/vendor/Server/Skills/arkts-code-check/references/PHASE1_INFO_COLLECTION.md +233 -222
- package/vendor/Server/Skills/arkts-code-check/references/REPORT_TEMPLATE.md +219 -219
- package/vendor/Server/Skills/arkts-library-compile-validate/SKILL.md +328 -328
- package/vendor/Server/Skills/arkts-library-compile-validate/scripts/build.ps1 +93 -93
- package/vendor/Server/Skills/arkts-library-compile-validate/scripts/code-linter.cjs +432 -432
- package/vendor/Server/Skills/arkts-library-compile-validate/scripts/migrate.cjs +851 -851
- package/vendor/Server/Skills/arkts-library-compile-validate/scripts/ohpm-switch.cjs +788 -788
- package/vendor/Server/Skills/arkts-library-demo-code/SKILL.md +291 -291
- package/vendor/Server/Skills/arkts-library-demo-code/references/API_SIGNATURE_CHECKS.md +68 -68
- package/vendor/Server/Skills/arkts-library-demo-code/references/BUILD_VALIDATION.md +184 -184
- package/vendor/Server/Skills/arkts-library-demo-code/references/CODE_STANDARDS.md +337 -337
- package/vendor/Server/Skills/arkts-library-demo-code/references/EXAMPLES.md +400 -400
- package/vendor/Server/Skills/arkts-library-demo-code/references/SYSTEM_API_LOOKUP.md +98 -98
- package/vendor/Server/Skills/arkts-library-demo-code/references/TEMPLATE.md +544 -544
- package/vendor/Server/Skills/arkts-library-demo-code/scripts/build.ps1 +93 -93
- package/vendor/Server/Skills/arkts-library-demo-code/scripts/code-linter.cjs +432 -432
- package/vendor/Server/Skills/arkts-library-demo-code/scripts/migrate.cjs +851 -851
- package/vendor/Server/Skills/arkts-library-demo-code/scripts/ohpm-switch.cjs +788 -788
- package/vendor/Server/Skills/arkts-library-demo-coverage/SKILL.md +174 -174
- package/vendor/Server/Skills/arkts-library-demo-scenario/SKILL.md +321 -321
- package/vendor/Server/Skills/arkts-library-demo-scenario/references/EXAMPLES.md +100 -100
- package/vendor/Server/Skills/arkts-library-demo-scenario/references/TEMPLATE.md +185 -185
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/SKILL.md +233 -233
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/assets/REPORT_TEMPLATE.md +102 -102
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/CHECK_DIMENSIONS.md +89 -89
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/COMPLIANCE_CHECKLIST.md +62 -62
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/KB_QUERY_GUIDE.md +107 -107
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/MCP_TOOL_DISCOVERY.md +124 -124
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/REPORT_TEMPLATE.md +90 -90
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/references/SCORING_FORMULA.md +57 -57
- package/vendor/Server/Skills/arkts-library-documentation-quality-check/scripts/validate-skill.cjs +259 -259
- package/vendor/Server/Skills/arkts-library-interface-spec/SKILL.md +97 -97
- package/vendor/Server/Skills/arkts-library-memory-leak-check/SKILL.md +391 -391
- package/vendor/Server/Skills/arkts-library-source-clone/SKILL.md +113 -113
- package/vendor/Server/Skills/arkts-library-stability-check/SKILL.md +312 -312
- package/vendor/Server/Skills/arkts-library-stability-check/assets/REPORT_TEMPLATE.md +154 -154
- package/vendor/Server/Skills/arkts-library-stability-check/references/CHECKLIST.md +165 -165
- package/vendor/Server/Skills/arkts-library-stability-check/references/CODE_EXAMPLES.md +308 -308
- package/vendor/Server/Skills/arkts-library-stability-check/references/SCORING_RULES.md +90 -90
- package/vendor/Server/Skills/arkts-library-stability-check/scripts/validate-skill.cjs +282 -282
- package/vendor/Server/Skills/arkts-library-test-coverage-check/SKILL.md +360 -360
- package/vendor/Server/Skills/arkts-library-test-coverage-check/assets/REPORT_TEMPLATE.md +145 -145
- package/vendor/Server/Skills/arkts-library-test-coverage-check/references/CHECKLIST.md +252 -252
- package/vendor/Server/Skills/arkts-library-test-coverage-check/references/MCP_TOOL_USAGE.md +114 -114
- package/vendor/Server/Skills/arkts-library-test-coverage-check/scripts/validate-skill.cjs +262 -262
- package/vendor/Server/Skills/arkts-library-xts-code/SKILL.md +455 -455
- package/vendor/Server/Skills/arkts-library-xts-code/assets/report-template.md +60 -60
- package/vendor/Server/Skills/arkts-library-xts-code/references/ACCESS_MODIFIER_PRECHECK.md +76 -76
- package/vendor/Server/Skills/arkts-library-xts-code/references/BUILD_VERIFICATION.md +200 -200
- package/vendor/Server/Skills/arkts-library-xts-code/references/CODE_STANDARDS.md +518 -518
- package/vendor/Server/Skills/arkts-library-xts-code/references/SUBAGENT_PROMPT_TEMPLATE.md +276 -276
- package/vendor/Server/Skills/arkts-library-xts-code/references/SYSTEM_API_LOOKUP.md +92 -92
- package/vendor/Server/Skills/arkts-library-xts-code/references/XTS_TEMPLATE.md +767 -767
- package/vendor/Server/Skills/arkts-library-xts-code/scripts/build.ps1 +93 -93
- package/vendor/Server/Skills/arkts-library-xts-code/scripts/code-linter.cjs +432 -432
- package/vendor/Server/Skills/arkts-library-xts-code/scripts/migrate.cjs +851 -851
- package/vendor/Server/Skills/arkts-library-xts-code/scripts/ohpm-switch.cjs +788 -788
- package/vendor/Server/Skills/arkts-library-xts-code/scripts/precheck-access-modifiers.cjs +221 -221
- package/vendor/Server/Skills/arkts-library-xts-code-fix/SKILL.md +228 -228
- package/vendor/Server/Skills/arkts-library-xts-coverage/SKILL.md +97 -97
- package/vendor/Server/Skills/arkts-library-xts-doc/SKILL.md +194 -194
- package/vendor/Server/Skills/arkts-library-xts-doc/references/EXAMPLES.md +575 -575
- package/vendor/Server/Skills/arkts-library-xts-doc/references/TEMPLATE.md +574 -574
- package/vendor/Server/Skills/arkts-library-xts-doc/references/TESTABILITY_GUIDE.md +182 -182
- package/vendor/Server/Skills/arkts-library-xts-execution/SKILL.md +490 -490
- package/vendor/Server/Skills/arkts-library-xts-execution/references/error-fixing-examples.md +217 -217
- package/vendor/Server/Skills/arkts-library-xts-execution/scripts/build.ps1 +93 -93
- package/vendor/Server/Skills/arkts-library-xts-execution/scripts/code-linter.cjs +432 -432
- package/vendor/Server/Skills/arkts-library-xts-execution/scripts/migrate.cjs +851 -851
- package/vendor/Server/Skills/arkts-library-xts-execution/scripts/ohpm-switch.cjs +788 -788
- package/vendor/Server/Skills/flutter-code-check/SKILL.md +299 -299
- package/vendor/Server/Skills/flutter-code-check/assets/OUTPUT_TEMPLATE.md +311 -311
- package/vendor/Server/Skills/flutter-code-check/references/CHECKLIST.md +190 -190
- package/vendor/Server/Skills/flutter-code-check/references/PLATFORMS.md +133 -133
- package/vendor/Server/Skills/flutter-code-check/scripts/validate-skill.cjs +259 -259
- package/vendor/Server/Skills/flutter-interface/README.md +75 -75
- package/vendor/Server/Skills/flutter-interface/SKILL.md +291 -291
- package/vendor/Server/Skills/flutter-interface/references/EXAMPLES.md +336 -336
- package/vendor/Server/Skills/flutter-interface/references/GIT_CLONE_GUIDE.md +190 -190
- package/vendor/Server/Skills/flutter-interface/references/SCRIPT_REFERENCE.md +258 -258
- package/vendor/Server/Skills/flutter-interface/references/TEMPLATE.md +254 -254
- package/vendor/Server/Skills/flutter-library-consistency-check/SKILL.md +517 -517
- package/vendor/Server/Skills/flutter-library-consistency-check/references/CHECKLIST.md +381 -381
- package/vendor/Server/Skills/flutter-library-consistency-check/references/FUNCTION_COMPARISON_GUIDE.md +341 -341
- package/vendor/Server/Skills/flutter-library-consistency-check/references/PLATFORM_LIMITATION_GUIDE.md +71 -71
- package/vendor/Server/Skills/flutter-library-documentation-quality-check/SKILL.md +518 -518
- package/vendor/Server/Skills/flutter-library-documentation-quality-check/references/CHECKLIST.md +406 -406
- package/vendor/Server/Skills/flutter-library-memory-leak-check/SKILL.md +652 -652
- package/vendor/Server/Skills/flutter-library-memory-leak-check/references/CHECKLIST.md +396 -396
- package/vendor/Server/Skills/flutter-library-stability-check/SKILL.md +744 -744
- package/vendor/Server/Skills/flutter-library-stability-check/references/CHECKLIST.md +720 -720
- package/vendor/Server/Skills/flutter-library-test-coverage-check/SKILL.md +414 -414
- package/vendor/Server/Skills/flutter-library-test-coverage-check/assets/REPORT_TEMPLATE.md +150 -150
- package/vendor/Server/Skills/flutter-library-test-coverage-check/references/CHECKLIST.md +304 -304
- package/vendor/Server/Skills/flutter-library-test-coverage-check/references/SCORING_RULES.md +265 -265
- package/vendor/Server/Skills/flutter-library-test-coverage-check/references/SCRIPT_USAGE.md +286 -286
- package/vendor/Server/Skills/knowledge-import/SKILL.md +383 -383
- package/vendor/Server/Skills/knowledge-import/references/MCP_TOOL_USAGE.md +165 -165
- package/vendor/Server/Skills/knowledge-import/references/SKILL_LOCATOR_GUIDE.md +91 -91
- package/vendor/Server/Skills/knowledge-import/references/SKILL_OPTIMIZATION_GUIDE.md +127 -127
- package/vendor/Server/Skills/ohos-lib-pr-push/SKILL.md +453 -301
- package/vendor/Server/Skills/ohos-lib-pr-push/assets/PR_CHECKLIST.md +151 -0
- package/vendor/Server/Skills/ohos-lib-pr-push/assets/PR_ISSUE_TEMPLATE.md +257 -105
- package/vendor/Server/Skills/ohos-lib-pr-push/references/GITCODE_API.md +191 -127
- package/vendor/Server/Skills/ohos-lib-pr-push/scripts/gitcode-api.cjs +317 -208
- package/vendor/Server/Skills/rn-code-check/SKILL.md +320 -320
- package/vendor/Server/Skills/rn-code-check/references/API-GUIDE.md +234 -234
- package/vendor/Server/Skills/rn-code-check/references/CHECKLIST.md +188 -188
- package/vendor/Server/Skills/rn-code-check/references/REPORT-TEMPLATE.md +246 -246
- package/vendor/Server/Skills/rn-lib-add-example/SKILL.md +198 -198
- package/vendor/Server/Skills/rn-lib-add-example/references/APP_RENAME_GUIDE.md +40 -40
- package/vendor/Server/Skills/rn-lib-add-example/references/SHELL_ADAPTATION_CHECKLIST.md +78 -78
- package/vendor/Server/Skills/rn-lib-add-example/references/TEMPLATE_REPO_GUIDE.md +70 -70
- package/vendor/Server/Skills/rn-lib-add-example/references/VERIFICATION_GUIDE.md +47 -47
- package/vendor/Server/Skills/rn-lib-add-example/scripts/create-example.cjs +252 -252
- package/vendor/Server/Skills/rn-lib-update-doc/SKILL.md +176 -176
- package/vendor/Server/Skills/rn-lib-update-doc/config.json +5 -5
- package/vendor/Server/Skills/rn-lib-update-doc/references/changelog-template.md +35 -35
- package/vendor/Server/Skills/rn-lib-update-doc/references/format-diff.md +137 -137
- package/vendor/Server/Skills/rn-lib-update-doc/references/link-registry.json +33 -33
- package/vendor/Server/Skills/rn-lib-update-doc/references/model-0.4.2-overview.md +40 -40
- package/vendor/Server/Skills/rn-lib-update-doc/references/model-0.4.2.md +429 -429
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/detect-readme-format.cjs +105 -105
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/find-usage-doc.cjs +90 -90
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/link-verify.cjs +213 -213
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/normalize-changelog.cjs +73 -73
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/normalize-package-meta.cjs +258 -258
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/normalize-readme-links.cjs +341 -341
- package/vendor/Server/Skills/rn-lib-update-doc/scripts/resolve-usage-docs.cjs +67 -67
- package/vendor/Server/Skills/rn-library-consistency-check/SKILL.md +299 -299
- package/vendor/Server/Skills/rn-library-consistency-check/assets/REPORT_TEMPLATE.md +293 -293
- package/vendor/Server/Skills/rn-library-consistency-check/references/ARKTS_COMPONENT_CHECK_GUIDE.md +857 -857
- package/vendor/Server/Skills/rn-library-consistency-check/references/ARKTS_TURBOMODULE_CHECK_GUIDE.md +856 -856
- package/vendor/Server/Skills/rn-library-consistency-check/references/CHECKLIST.md +157 -157
- package/vendor/Server/Skills/rn-library-consistency-check/references/CPP_COMPONENT_CHECK_GUIDE.md +801 -801
- package/vendor/Server/Skills/rn-library-consistency-check/references/CPP_TURBOMODULE_CHECK_GUIDE.md +683 -683
- package/vendor/Server/Skills/rn-library-consistency-check/references/FUNCTION_COMPARISON_GUIDE.md +233 -233
- package/vendor/Server/Skills/rn-library-consistency-check/references/NATIVE_COMPONENT_IDENTIFICATION.md +1373 -1373
- package/vendor/Server/Skills/rn-library-consistency-check/references/SCORING_STANDARD.md +220 -220
- package/vendor/Server/Skills/rn-library-consistency-check/scripts/validate-skill.py +245 -245
- package/vendor/Server/Skills/rn-library-documentation-quality-check/SKILL.md +263 -263
- package/vendor/Server/Skills/rn-library-documentation-quality-check/assets/MODEL.md +414 -414
- package/vendor/Server/Skills/rn-library-documentation-quality-check/assets/MODEL_en.md +413 -413
- package/vendor/Server/Skills/rn-library-documentation-quality-check/assets/REPORT_TEMPLATE.md +311 -311
- package/vendor/Server/Skills/rn-library-documentation-quality-check/references/CHECK_CHECKLIST.md +355 -355
- package/vendor/Server/Skills/rn-library-documentation-quality-check/references/CROSS_VALIDATION_GUIDE.md +115 -115
- package/vendor/Server/Skills/rn-library-documentation-quality-check/references/DOC_COLLECTION_GUIDE.md +139 -139
- package/vendor/Server/Skills/rn-library-documentation-quality-check/references/EXAMPLES.md +586 -586
- package/vendor/Server/Skills/rn-library-documentation-quality-check/references/GOTCHAS.md +57 -57
- package/vendor/Server/Skills/rn-library-documentation-quality-check/scripts/validate-skill.py +259 -259
- package/vendor/Server/Skills/rn-library-interface-analyzer/SKILL.md +301 -301
- package/vendor/Server/Skills/rn-library-interface-analyzer/assets/REPORT_TEMPLATE.md +148 -148
- package/vendor/Server/Skills/rn-library-interface-analyzer/references/DOC_ANNOTATION_GUIDE.md +118 -118
- package/vendor/Server/Skills/rn-library-interface-analyzer/references/SCRIPT_USAGE_GUIDE.md +168 -168
- package/vendor/Server/Skills/rn-library-interface-analyzer/references/URL_PARSING_RULES.md +176 -176
- package/vendor/Server/Skills/rn-library-issue-generalizer/SKILL.md +274 -274
- package/vendor/Server/Skills/rn-library-issue-generalizer/assets/case-template.md +45 -45
- package/vendor/Server/Skills/rn-library-issue-generalizer/assets/rule-template.md +25 -25
- package/vendor/Server/Skills/rn-library-issue-generalizer/references/PR_FETCH_GUIDE.md +61 -61
- package/vendor/Server/Skills/rn-library-issue-generalizer/references/RULE_TEMPLATE_GUIDE.md +165 -165
- package/vendor/Server/Skills/rn-library-issue-generalizer/scripts/fetch-pr-info.py +239 -239
- package/vendor/Server/Skills/rn-library-known-issue-check/SKILL.md +263 -263
- package/vendor/Server/Skills/rn-library-known-issue-check/assets/REPORT_TEMPLATE.md +96 -96
- package/vendor/Server/Skills/rn-library-known-issue-check/references/COMPLIANCE_CHECKLIST.md +57 -57
- package/vendor/Server/Skills/rn-library-known-issue-check/references/INSPECTION_GUIDE.md +99 -99
- package/vendor/Server/Skills/rn-library-known-issue-check/references/PRESCREEN_GUIDE.md +64 -64
- package/vendor/Server/Skills/rn-library-known-issue-check/references/SOURCE_PREP_GUIDE.md +74 -74
- package/vendor/Server/Skills/rn-library-known-issue-check/scripts/validate-known-issue-report.py +164 -164
- package/vendor/Server/Skills/rn-library-memory-leak-check/SKILL.md +356 -339
- package/vendor/Server/Skills/rn-library-memory-leak-check/assets/REPORT_TEMPLATE.md +85 -83
- package/vendor/Server/Skills/rn-library-memory-leak-check/references/CHECKLIST.md +905 -859
- package/vendor/Server/Skills/rn-library-memory-leak-check/references/HARMONY_CODE_PATTERNS.md +124 -122
- package/vendor/Server/Skills/rn-library-memory-leak-check/scripts/scan_harmony_code.py +287 -279
- package/vendor/Server/Skills/rn-library-stability-check/SKILL.md +273 -273
- package/vendor/Server/Skills/rn-library-stability-check/assets/REPORT_TEMPLATE.md +129 -129
- package/vendor/Server/Skills/rn-library-stability-check/references/CHECKLIST.md +581 -581
- package/vendor/Server/Skills/rn-library-stability-check/references/SCORING_RULES.md +138 -138
- package/vendor/Server/Skills/rn-library-stability-check/scripts/scan-harmony-code.py +168 -168
- package/vendor/Server/Skills/rn-library-test-coverage-check/SKILL.md +526 -506
- package/vendor/Server/Skills/rn-library-test-coverage-check/references/CHECKLIST.md +321 -280
- package/vendor/Server/Skills/rn-library-test-coverage-check/references/DEMO_LOCATION.md +221 -221
- package/vendor/Server/Skills/rn-library-test-coverage-check/references/REPORT_TEMPLATE.md +220 -209
- package/vendor/Server/Skills/rn-library-test-coverage-check/references/SCRIPT_USAGE.md +325 -325
- package/vendor/Server/Skills/rn-ohos-xts-generator/SKILL.md +279 -279
- package/vendor/Server/Skills/rn-ohos-xts-generator/assets/TEST_FILE_TEMPLATES.md +404 -404
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/BUILD_TROUBLESHOOTING.md +185 -185
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/BUILD_WORKFLOW.md +265 -265
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/COMMON_CONFIG.md +189 -189
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/CONFIG_GUIDE.md +203 -203
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/COVERAGE_ANALYZER.md +147 -147
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/DESIGN_DOC_GUIDE.md +148 -148
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/GENERATION_FLOW.md +165 -165
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/GENERATION_STRATEGY.md +195 -195
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/HARMONY_SCANNER.md +249 -249
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/JEST_FRAMEWORK.md +235 -235
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/PLATFORM_COMPAT.md +161 -161
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/RN_TEST_PATTERNS.md +413 -413
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/SOURCE_PARSER.md +235 -235
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/TEST_CONVENTIONS.md +245 -245
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/TROUBLESHOOTING.md +282 -282
- package/vendor/Server/Skills/rn-ohos-xts-generator/references/USAGE_GUIDE.md +251 -251
- package/vendor/Server/Skills/rnoh-cptf-api-test/SKILL.md +469 -469
- package/vendor/Server/Skills/rnoh-cptf-api-test/assets/CPTF_TEST_TEMPLATE.md +310 -310
- package/vendor/Server/Skills/rnoh-cptf-api-test/assets/DEMO_PAGE_TEMPLATE.md +303 -303
- package/vendor/Server/Skills/rnoh-cptf-api-test/references/CPTF_TEST_GENERATION_GUIDE.md +421 -421
- package/vendor/Server/Skills/rnoh-cptf-api-test/references/DEMO_GENERATION_GUIDE.md +358 -358
- package/vendor/Server/Skills/rnoh-cptf-api-test/references/QUALITY_CHECKLIST.md +114 -114
- package/vendor/Server/Skills/rnoh-cptf-api-test/references/SPEC_PARSING_GUIDE.md +274 -274
- package/vendor/Server/Skills/rnoh-cptf-api-test/scripts/validate-rnoh-cptf-api-test.sh +185 -185
- package/vendor/Server/Skills/rnoh-cptf-demo-test/SKILL.md +191 -191
- package/vendor/Server/Skills/rnoh-cptf-demo-test/assets/TEST_TEMPLATE.md +216 -216
- package/vendor/Server/Skills/rnoh-cptf-demo-test/references/CPTF_SETUP.md +107 -107
- package/vendor/Server/Skills/rnoh-cptf-demo-test/references/DEMO_ANALYSIS.md +120 -120
- package/vendor/Server/Skills/rnoh-cptf-demo-test/scripts/validate-rnoh-cptf-test.sh +108 -108
- package/vendor/Server/Skills/rnoh-cptf-test-run/SKILL.md +237 -237
- package/vendor/Server/Skills/rnoh-cptf-test-run/references/DEBUG_PLAYBOOK.md +261 -261
- package/vendor/Server/Skills/rnoh-cptf-test-run/scripts/validate-run-env.sh +112 -112
- package/vendor/Server/Skills/rnoh-lib-code-adapt/SKILL.md +497 -497
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/adapt-checklist.md +270 -270
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/api-migration-checklist.md +164 -164
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/common-compile-errors.md +556 -556
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/deveco-cli-tools.md +459 -459
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/edge-cases.md +65 -65
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/har-tgz-build.md +512 -512
- package/vendor/Server/Skills/rnoh-lib-code-adapt/references/version-compat-matrix.md +132 -132
- package/vendor/Server/Skills/rnoh-lib-code-adapt/scripts/auto-integrate.sh +424 -424
- package/vendor/Server/Skills/rnoh-lib-demo-coverage/SKILL.md +137 -137
- package/vendor/Server/Skills/rnoh-lib-demo-create/SKILL.md +306 -306
- package/vendor/Server/Skills/rnoh-lib-demo-create/assets/DEMO_PAGE_TEMPLATE.md +485 -485
- package/vendor/Server/Skills/rnoh-lib-demo-create/assets/INDEX_TEMPLATE.md +172 -172
- package/vendor/Server/Skills/rnoh-lib-demo-create/references/DEMO_CODE_RULES.md +422 -422
- package/vendor/Server/Skills/rnoh-lib-demo-create/references/QUALITY_CHECKLIST.md +95 -95
- package/vendor/Server/Skills/rnoh-lib-demo-create/references/SOURCE_EXPLORATION.md +169 -169
- package/vendor/Server/Skills/rnoh-lib-demo-doc/SKILL.md +554 -554
- package/vendor/Server/Skills/rnoh-lib-demo-doc/assets/DEMO_DOC_TEMPLATE.md +106 -106
- package/vendor/Server/Skills/rnoh-lib-demo-doc/references/COVERAGE_INCREMENTAL.md +216 -216
- package/vendor/Server/Skills/rnoh-lib-demo-doc/references/DEMO_DESIGN_RULES.md +413 -413
- package/vendor/Server/Skills/rnoh-lib-demo-doc/references/OUTPUT_FORMAT.md +269 -269
- package/vendor/Server/Skills/rnoh-lib-demo-doc/references/QUALITY_CHECKLIST.md +98 -98
- package/vendor/Server/Skills/rnoh-lib-func-test/SKILL.md +337 -337
- package/vendor/Server/Skills/rnoh-lib-rnt-search/SKILL.md +722 -722
- package/vendor/Server/Skills/rnoh-lib-rnt-search/assets/PORT_REPORT_TEMPLATE.md +219 -219
- package/vendor/Server/Skills/rnoh-lib-rnt-search/references/DEMO_PORTING_GUIDE.md +345 -345
- package/vendor/Server/Skills/rnoh-lib-rnt-search/references/PORT_VERIFICATION.md +269 -269
- package/vendor/Server/Skills/rnoh-lib-rnt-search/references/RNT_PROJECT_STRUCTURE.md +173 -173
- package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/analyze-demo-deps.cjs +267 -267
- package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/detect-rnoh-version.cjs +174 -174
- package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/find-rnt-demo.sh +111 -111
- package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/port-demo.sh +186 -186
- package/vendor/Server/Skills/rnoh-lib-rnt-search/scripts/read-lib-meta.cjs +150 -150
- package/vendor/Server/Skills/rnoh-lib-test-align/SKILL.md +296 -296
- package/vendor/Server/Skills/rnoh-lib-test-align/references/jest-troubleshooting.md +371 -371
- package/vendor/Server/Skills/rnoh-lib-test-align/references/port-test-demo-guide.md +212 -212
- package/vendor/Server/Skills/rnoh-lib-test-align/references/runtime-troubleshooting.md +345 -345
- package/vendor/Server/Skills/rnoh-lib-test-align/references/unit-test-template.md +223 -223
- package/vendor/Server/Skills/rnoh-lib-test-align/scripts/port-test-demo.sh +1053 -1053
- package/vendor/Server/Skills/rnoh-lib-version-diff/SKILL.md +295 -255
- package/vendor/Server/Skills/rnoh-lib-version-diff/references/OHOS_ADAPTATION.md +82 -77
- package/vendor/Server/Skills/rnoh-lib-version-diff/references/OHOS_API_LOOKUP.md +224 -224
- package/vendor/Server/Skills/rnoh-lib-version-diff/references/script-reference.md +175 -174
- package/vendor/Server/Skills/rnoh-lib-version-diff/scripts/detect-upstream-version.js +967 -967
- package/vendor/Server/Skills/rnoh-lib-version-diff/scripts/generate-diff.js +1798 -1798
- package/vendor/Server/Skills/rnoh-lib-version-diff/scripts/package.json +5 -5
- package/vendor/Server/Skills/rnoh-lib-version-diff/templates/report-template.md +180 -137
- package/vendor/Server/Skills/rnoh-lib-xts-coverage/SKILL.md +145 -145
- package/vendor/Server/Skills/skill-generator/SKILL.md +365 -365
- package/vendor/Server/Skills/skill-generator/assets/SKILL_TEMPLATE.md +183 -183
- package/vendor/Server/Skills/skill-generator/references/COMPLIANCE_CHECKLIST.md +82 -82
- package/vendor/Server/Skills/skill-generator/references/KB_QUERY_GUIDE.md +110 -110
- package/vendor/Server/Skills/skill-generator/references/MCP_TOOL_DISCOVERY.md +122 -122
- package/vendor/Server/Skills/skill-generator/references/SKILL_SPEC.md +121 -121
- package/vendor/Server/Skills/skill-generator/scripts/validate-skill.cjs +259 -259
- package/vendor/Server/Skills/task-analysis/SKILL.md +234 -234
- package/vendor/Server/Skills/task-analysis/assets/OUTPUT_EXAMPLES.md +160 -160
- package/vendor/Server/Skills/task-analysis/references/ACCEPTANCE_CRITERIA_GUIDE.md +190 -190
- package/vendor/Server/Skills/task-analysis/references/ANALYSIS_SCHEMA.md +224 -224
- package/vendor/Server/Skills/task-analysis/references/INTEGRATION_CONTEXT.md +162 -162
- package/vendor/Server/Skills/task-analysis/references/LESSONS_LEARNED.md +55 -55
- package/vendor/Server/Skills/task-analysis/references/REPLAN_CONTEXT_GUIDE.md +126 -126
- package/vendor/Server/Skills/task-analysis/scripts/validate-analysis-output.sh +256 -256
- package/vendor/Server/Skills/task-decomposition/SKILL.md +528 -528
- package/vendor/Server/Skills/task-decomposition/assets/OUTPUT_EXAMPLES.md +451 -451
- package/vendor/Server/Skills/task-decomposition/references/ACCEPTANCE_CRITERIA_GUIDE.md +179 -179
- package/vendor/Server/Skills/task-decomposition/references/DEPENDENCY_GRAPH_GUIDE.md +152 -152
- package/vendor/Server/Skills/task-decomposition/references/INTEGRATION_CONTEXT.md +175 -175
- package/vendor/Server/Skills/task-decomposition/references/REPLAN_CONTEXT_GUIDE.md +195 -195
- package/vendor/Server/Skills/task-decomposition/references/TASK_DECOMPOSITION_TEMPLATES.md +226 -226
- package/vendor/Server/Skills/task-decomposition/scripts/list-available-skills.cjs +263 -263
- package/vendor/Server/Skills/task-decomposition/scripts/skill-blacklist.json +29 -29
- package/vendor/Server/Skills/task-decomposition/scripts/validate-decomposition-output.cjs +376 -376
- package/vendor/Server/Skills/task-decomposition/scripts/validate-param-consistency.cjs +259 -259
- package/vendor/Server/Skills/task-decomposition/scripts/validate-specified-skills.cjs +216 -216
- package/vendor/Server/Skills/task-decomposition/scripts/validate-step-graph.cjs +424 -424
- package/vendor/Server/Skills/tpc-cpp-check/SKILL.md +427 -427
- package/vendor/Server/Skills/tpc-cpp-check/references/CHECKLIST.md +214 -214
- package/vendor/Server/Skills/tpc-cpp-check/references/HPKBUILD_GUIDE.md +235 -235
- package/vendor/Server/Skills/tpc-cpp-check/references/REPORT_TEMPLATE.md +250 -250
- package/vendor/Server/TestCheck/TestCheck.js +775 -775
- package/vendor/Server/TestCheck/index.js +11 -11
- package/vendor/Server/library/McpToolGuide.js +280 -280
- package/vendor/Server/library/StatsService.js +126 -126
- package/vendor/Server/library/cstTime.js +16 -16
- package/vendor/VERSION +3 -3
- package/workflows/pr-check.mjs +105 -105
- package/workflows/pr-push.mjs +193 -0
- package/vendor/Server/Agent/SkillSelector/types.js +0 -63
package/vendor/Server/Skills/flutter-library-documentation-quality-check/references/CHECKLIST.md
CHANGED
|
@@ -1,407 +1,407 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: flutter-library-documentation-quality-check
|
|
3
|
-
description: 对 Flutter 三方库的**鸿蒙化代码相关文档**进行文档质量检视,核心检视 README.OpenHarmony.md 等鸿蒙化专属文档(而非上游原始 README.md),评估鸿蒙化文档的完整性、准确性、易读性,特别关注鸿蒙化接口说明、三方库调用方式、Flutter版本对应关系等关键内容,生成严苛评分报告(0-100分)。作为 Flutter 仓库检视流程的第六阶段,依赖内存泄露检视结果。
|
|
4
|
-
license: Apache-2.0
|
|
5
|
-
compatibility: 需要访问 Git 仓库、智能识别鸿蒙化相关文档、分析文档内容
|
|
6
|
-
metadata:
|
|
7
|
-
author: CPPAgent
|
|
8
|
-
version: "3.0"
|
|
9
|
-
---
|
|
10
|
-
|
|
11
|
-
# FlutterLibraryDocumentationQualityCheckSkill
|
|
12
|
-
|
|
13
|
-
对 Flutter 三方库的**鸿蒙化代码相关文档**进行文档质量检视,评估鸿蒙化文档的完整性、准确性、易读性,特别关注鸿蒙化接口说明、三方库调用方式、Flutter版本对应关系等关键内容。
|
|
14
|
-
|
|
15
|
-
> ⚠️ **核心定位**:本 SKILL **仅检视鸿蒙化代码相关文档**,不关注非鸿蒙化部分的文档。检视核心是 README.OpenHarmony.md 等鸿蒙专属文档。**上游原始 README.md 不纳入鸿蒙化检视评分**——很多仓库的 README.md 是上游原始项目文档,鸿蒙化内容应正确放置在专属文档中,不因原始 README.md 缺少鸿蒙内容而扣分。通过**智能搜索识别鸿蒙化相关文档**,分析文档的完整性、准确性、易读性等方面。
|
|
16
|
-
|
|
17
|
-
---
|
|
18
|
-
|
|
19
|
-
## 任务参数
|
|
20
|
-
|
|
21
|
-
| 参数 | 必需 | 说明 |
|
|
22
|
-
|------|------|------|
|
|
23
|
-
| `repoUrl` | ✅ | Git 仓库地址,支持分支 `?branch=xxx` |
|
|
24
|
-
| `outputDir` | ✅ | 输出目录绝对路径,存放检视报告 |
|
|
25
|
-
| `interfaceDocPath` | ✅ | 接口规格说明文档路径(用于准确性交叉验证) |
|
|
26
|
-
| `repoName` | ✅ | 仓库名称(用于报告标识) |
|
|
27
|
-
|
|
28
|
-
---
|
|
29
|
-
|
|
30
|
-
## 输入依赖
|
|
31
|
-
|
|
32
|
-
本 SKILL 是 Flutter 仓库检视流程的**第六阶段**,依赖:
|
|
33
|
-
|
|
34
|
-
- **前置 SKILL**: `flutter-library-memory-leak-check`
|
|
35
|
-
- **输入文件**: `接口规格说明.md`、`内存泄露检视报告.md`
|
|
36
|
-
- **仓库源码**: 已克隆到 `{outputDir}/source/`
|
|
37
|
-
|
|
38
|
-
---
|
|
39
|
-
|
|
40
|
-
## 工作流程
|
|
41
|
-
|
|
42
|
-
### Phase 0:鸿蒙化相关文档智能定位
|
|
43
|
-
|
|
44
|
-
**通过多维度搜索策略**,智能识别鸿蒙化相关文档,而非检视所有文档。
|
|
45
|
-
|
|
46
|
-
#### 0.1 鸿蒙化文档搜索策略(优先级递减)
|
|
47
|
-
|
|
48
|
-
| 搜索维度 | 文件特征 | 权重 | 说明 |
|
|
49
|
-
|----------|----------|------|------|
|
|
50
|
-
| **鸿蒙专属文档** | `README.OpenHarmony.md`、`README.OpenHarmony_CN.md`、`README.openharmony.md`、`README.harmony.md`、`README.ohos.md` 及包级子目录同名文件 | ⭐⭐⭐⭐ 最高 | 鸿蒙化专属文档,是检视核心 |
|
|
51
|
-
| **README 鸿蒙章节** | 根/包 README.md 中包含 "ohos"、"harmony"、"openharmony"、"鸿蒙" 等关键词 | ⭐⭐⭐ 高 | 仅当**不存在鸿蒙专属文档时**才检视 |
|
|
52
|
-
| **鸿蒙配置文档** | `oh-package.json5`、`module.json5`、`build-profile.json5` | ⭐⭐ 中 | 鸿蒙模块配置(辅助参考) |
|
|
53
|
-
| **API 文档鸿蒙部分** | API 文档中包含鸿蒙化接口说明 | ⭐⭐ 中 | API 文档的鸿蒙化内容 |
|
|
54
|
-
| **示例文档鸿蒙部分** | example 目录中的鸿蒙化示例说明 | ⭐ 低 | 示例文档的鸿蒙化内容 |
|
|
55
|
-
|
|
56
|
-
#### 0.2 搜索执行流程
|
|
57
|
-
|
|
58
|
-
```bash
|
|
59
|
-
# Step 1: 搜索鸿蒙特定 README 文件(最高优先级)
|
|
60
|
-
# 注意:使用通配符匹配大小写变体和语言后缀变体(_CN, _zh 等)
|
|
61
|
-
find {sourceDir} -iname "README.*harmony*" -o -iname "README.*ohos*" -o -iname "README.*openharmony*" -type f
|
|
62
|
-
|
|
63
|
-
# Step 2: 同时检查根目录和包级子目录(如 kraken/, lib/ 等)
|
|
64
|
-
# Flutter 项目常见结构:根目录简版 + 包级详细版
|
|
65
|
-
find {sourceDir} -maxdepth 2 -iname "README.*harmony*" -o -iname "README.*ohos*" -o -iname "README.*openharmony*" -type f
|
|
66
|
-
|
|
67
|
-
# Step 3: 若未发现鸿蒙专属文档,才搜索 README.md 中的鸿蒙章节
|
|
68
|
-
grep -n -i "ohos|harmony|openharmony|鸿蒙|harmonyos" {sourceDir}/README.md
|
|
69
|
-
|
|
70
|
-
# Step 4: 搜索 CHANGELOG.md 中的鸿蒙化变更记录
|
|
71
|
-
find {sourceDir} -name "CHANGELOG.md" -type f | xargs grep -l -i "ohos|harmony|openharmony|鸿蒙|harmonyos"
|
|
72
|
-
|
|
73
|
-
# Step 5: 搜索 example 目录中的鸿蒙化示例说明
|
|
74
|
-
find {sourceDir} -path "*/example/*" -name "README.md" -type f | xargs grep -l -i "ohos|harmony|openharmony|鸿蒙"
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
#### 0.3 鸿蒙化文档定位结果分类
|
|
78
|
-
|
|
79
|
-
根据搜索结果,将文档分为以下类别:
|
|
80
|
-
|
|
81
|
-
```
|
|
82
|
-
检视范围判定:
|
|
83
|
-
├── 鸿蒙核心文档(必检视)
|
|
84
|
-
│ ├── README.OpenHarmony.md / README.openharmony.md ✅ 检视(最高优先级)
|
|
85
|
-
│ ├── README.OpenHarmony_CN.md / 中文变体 ✅ 检视(最高优先级)
|
|
86
|
-
│ ├── README.harmony.md ✅ 检视(最高优先级)
|
|
87
|
-
│ ├── README.ohos.md ✅ 检视(最高优先级)
|
|
88
|
-
│ ├── 包级子目录同名文件(如 kraken/README.OpenHarmony.md)✅ 检视(最高优先级)
|
|
89
|
-
│ ├── CHANGELOG.md 鸿蒙变更 ✅ 检视
|
|
90
|
-
│ └── API 文档鸿蒙接口说明 ✅ 检视
|
|
91
|
-
├── 鸿蒙替代文档(仅当专属文档不存在时检视)
|
|
92
|
-
│ └── README.md 鸿蒙章节 ⚠️ 替代检视(专属文档缺失时)
|
|
93
|
-
├── 鸿蒙辅助文档(辅助检视)
|
|
94
|
-
│ ├── oh-package.json5 说明 ⚠️ 辅助参考
|
|
95
|
-
│ ├── module.json5 说明 ⚠️ 辅助参考
|
|
96
|
-
│ └── example 鸿蒙示例 ⚠️ 辅助参考
|
|
97
|
-
├── 非鸿蒙文档(不检视,不扣分)
|
|
98
|
-
│ ├── README.md 上游原始内容 ❌ 不检视、不扣分(如 Android/iOS 说明)
|
|
99
|
-
│ ├── CHANGELOG.md 其他变更 ❌ 不检视
|
|
100
|
-
│ ├── API 文档非鸿蒙接口 ❌ 不检视
|
|
101
|
-
│ └── example 其他平台示例 ❌ 不检视
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
#### 0.4 判定规则
|
|
105
|
-
|
|
106
|
-
| 搜索结果 | 判定 | 评分 | 后续操作 |
|
|
107
|
-
|----------|------|------|----------|
|
|
108
|
-
| 发现 `README.OpenHarmony.md` 等(含 `_CN` 变体、包级文件) | ✅ 存在鸿蒙专属文档 | 正常评分 | 进入 Phase 1 深度检视,**README.md 不纳入鸿蒙化扣分** |
|
|
109
|
-
| 仅 README.md 包含鸿蒙章节(无专属文档) | ⚠️ 缺少专属文档 | 正常评分但1.1扣15分 | 进入 Phase 1,检视 README.md 鸿蒙章节替代专属文档 |
|
|
110
|
-
| 仅发现配置文件无说明文档 | ⚠️ 文档缺失严重 | 20-40 分 | 报告标注"鸿蒙化文档严重缺失" |
|
|
111
|
-
| 未发现任何鸿蒙文档特征 | ❌ 鸿蒙化文档缺失 | **0 分** | 报告标注"未发现鸿蒙化相关文档" |
|
|
112
|
-
| 无法访问源码目录 | ❌ 无法检视 | **0 分** | 报告标注"源码目录不可访问" |
|
|
113
|
-
|
|
114
|
-
**重要说明**:
|
|
115
|
-
- **上游 README.md 不扣分**:README.md 通常是上游原始项目文档,鸿蒙化内容应放在 README.OpenHarmony.md 等专属文档中。**当专属文档存在时,README.md 缺少鸿蒙内容不扣分**
|
|
116
|
-
- **专属文档优先**:README.OpenHarmony.md 等鸿蒙专属文档是检视核心,缺失将严重扣分
|
|
117
|
-
- **多层级文档**:根目录简版 + 包级详细版 是常见的合理结构,两者均需检视
|
|
118
|
-
|
|
119
|
-
---
|
|
120
|
-
|
|
121
|
-
### Phase 1:鸿蒙化文档完整性检查(致命项,40分)
|
|
122
|
-
|
|
123
|
-
#### 1.1 鸿蒙专属文档存在性检查(致命项,15分)
|
|
124
|
-
|
|
125
|
-
| 检查项 | 要求 | 扣分规则 |
|
|
126
|
-
|--------|------|----------|
|
|
127
|
-
| README.OpenHarmony.md 等存在 | 应有鸿蒙专属 README 文件(含 `_CN` 变体) | **缺失扣 15 分(致命)** |
|
|
128
|
-
| 鸿蒙文档位置正确 | 位于根目录、docs 目录或包级子目录 | 位置不当扣 3 分 |
|
|
129
|
-
| 鸿蒙文档命名规范 | 使用标准命名格式(大小写不扣分) | 命名不规范扣 2 分(大小写不扣分) |
|
|
130
|
-
| 鸿蒙文档内容非空 | 文档内容不为空或仅占位符 | 为空扣 10 分 |
|
|
131
|
-
|
|
132
|
-
#### 1.2 README.md 鸿蒙章节完整性(严苛项,15分)
|
|
133
|
-
|
|
134
|
-
**关键规则**:本节仅在**不存在鸿蒙专属文档时**启用。当 README.OpenHarmony.md 等专属文档存在时,README.md 作为上游原始文档,其缺少鸿蒙内容**不扣分**,本节直接满分 15 分。
|
|
135
|
-
|
|
136
|
-
**场景 A:鸿蒙专属文档存在 → 本节满分 15/15,无需检视 README.md 鸿蒙章节**
|
|
137
|
-
|
|
138
|
-
**场景 B:鸿蒙专属文档不存在 → 检视 README.md 鸿蒙章节替代专属文档**:
|
|
139
|
-
|
|
140
|
-
| 检查项 | 要求 | 扣分规则 |
|
|
141
|
-
|--------|------|----------|
|
|
142
|
-
| 鸿蒙平台支持说明 | README.md 明确说明支持鸿蒙/OpenHarmony 平台 | **缺失扣 10 分** |
|
|
143
|
-
| 鸿蒙安装配置说明 | README.md 提供鸿蒙平台的安装和配置步骤 | 缺失扣 8 分 |
|
|
144
|
-
| 鸿蒙平台差异说明 | README.md 说明鸿蒙平台与其他平台的差异 | 缺失扣 5 分 |
|
|
145
|
-
| 鸿蒙版本要求说明 | README.md 说明鸿蒙系统版本要求 | 缺失扣 5 分 |
|
|
146
|
-
|
|
147
|
-
#### 1.3 Flutter 版本对应关系说明(致命项,10分)
|
|
148
|
-
|
|
149
|
-
**这是用户明确要求的核心检查项**:
|
|
150
|
-
|
|
151
|
-
| 检查项 | 要求 | 扣分规则 |
|
|
152
|
-
|--------|------|----------|
|
|
153
|
-
| Flutter 版本对应说明 | 清晰说明 Flutter 框架版本与三方库版本对应关系 | **缺失扣 10 分(致命)** |
|
|
154
|
-
| 版本对应表完整 | 提供版本对应表,包含关键维度列 | 缺少关键列扣 5 分 |
|
|
155
|
-
| 版本兼容性说明 | 说明版本兼容性和不兼容情况 | 缺失扣 3 分 |
|
|
156
|
-
| 升级迁移说明 | 说明版本升级的迁移方法 | 缺失扣 2 分 |
|
|
157
|
-
|
|
158
|
-
**版本对应表完整性判定**:
|
|
159
|
-
|
|
160
|
-
| 情况 | 判定 | 扣分 |
|
|
161
|
-
|------|------|------|
|
|
162
|
-
| 表格仅有当前版本一行数据(新适配库常见) | ✅ 合理完整 | **0 分** |
|
|
163
|
-
| 表格缺少关键维度列(如缺少 Flutter 框架版本列、TAG 列、分支列) | ⚠️ 不完整 | -5 分 |
|
|
164
|
-
| 表格信息与接口规格说明不一致 | ⚠️ 不准确 | -3 分 |
|
|
165
|
-
| 完全无版本对应表 | ❌ 致命缺失 | -10 分 |
|
|
166
|
-
|
|
167
|
-
**版本对应说明示例**:
|
|
168
|
-
|
|
169
|
-
```markdown
|
|
170
|
-
### TAG 版本对应表
|
|
171
|
-
|
|
172
|
-
| Flutter 框架版本 | TAG | 分支 |
|
|
173
|
-
|-----------------|-----|------|
|
|
174
|
-
| 3.22 | 4.2.3-ohos-1.0.0-beta.1 | br_3.27 |
|
|
175
|
-
| 3.27 | 4.2.3-ohos-1.0.0-beta.1 | br_3.27 |
|
|
176
|
-
| 3.35 | 4.2.3-ohos-1.0.0-beta.1 | br_3.27 |
|
|
177
|
-
```
|
|
178
|
-
|
|
179
|
-
---
|
|
180
|
-
|
|
181
|
-
### Phase 2:鸿蒙化接口说明准确性检查(严苛项,30分)
|
|
182
|
-
|
|
183
|
-
> ⚠️ **准确性交叉验证**:本 Phase 要求**读取 `{interfaceDocPath}`(接口规格说明.md)**,将文档中的 API 名称、参数类型、版本信息与接口规格说明进行对比,确保文档描述与实际实现一致。
|
|
184
|
-
|
|
185
|
-
#### 2.1 鸿蒙化接口说明完整性(严苛项,10分)
|
|
186
|
-
|
|
187
|
-
**这是用户明确要求的核心检查项**:
|
|
188
|
-
|
|
189
|
-
| 检查项 | 要求 | 扣分规则 |
|
|
190
|
-
|--------|------|----------|
|
|
191
|
-
| 鸿蒙化接口列表 | 文档列出所有鸿蒙化实现的接口,标注 OHOS 支持状态 | **缺失扣 6 分** |
|
|
192
|
-
| 接口功能说明 | 每个鸿蒙化接口有清晰的功能说明 | 缺失扣 3 分 |
|
|
193
|
-
| 接口使用示例 | 提供接口使用示例代码 | 缺失扣 2 分 |
|
|
194
|
-
|
|
195
|
-
#### 2.2 三方库调用方式说明(严苛项,10分)
|
|
196
|
-
|
|
197
|
-
**这是用户明确要求的核心检查项**:
|
|
198
|
-
|
|
199
|
-
| 检查项 | 要求 | 扣分规则 |
|
|
200
|
-
|--------|------|----------|
|
|
201
|
-
| 调用方式说明 | 清晰说明三方库的调用方式(依赖添加 → 导入 → 创建 → 使用) | **缺失扣 10 分** |
|
|
202
|
-
| OHOS 环境配置步骤 | 提供详细的 OHOS 开发环境配置步骤(DevEco、SDK、编译) | 缺失扣 5 分 |
|
|
203
|
-
| 调用示例代码 | 提供完整的调用示例代码 | 缺失扣 5 分 |
|
|
204
|
-
|
|
205
|
-
#### 2.3 接口文档与库内文档双向对照(致命项,10分)
|
|
206
|
-
|
|
207
|
-
> ⚠️ **双向对照核心机制**:从接口规格说明出发验证库内文档覆盖度(正向),从库内文档出发验证接口规格说明一致性(反向),确保双向一致。
|
|
208
|
-
|
|
209
|
-
##### 2.3.1 正向对照:接口规格说明 → 库内文档覆盖度(5分)
|
|
210
|
-
|
|
211
|
-
| 检查项 | 验证方法 | 扣分规则 |
|
|
212
|
-
|--------|----------|----------|
|
|
213
|
-
| 接口覆盖完整性 | 读取接口规格说明中列出的每个接口,在库内文档中搜索是否均有描述 | 覆盖率 <80% 扣 3 分,<50% 扣 5 分 |
|
|
214
|
-
| 关键属性覆盖 | 检查库内文档是否描述了接口规格说明中的关键属性(参数列表、返回值、异常说明) | 遗漏关键属性每项扣 1 分,上限 3 分 |
|
|
215
|
-
| 参数说明对照 | 对比接口规格说明中每个接口的参数(名称、类型、可选/必填),与库内文档描述是否一致 | 不一致每处扣 1 分,上限 3 分 |
|
|
216
|
-
|
|
217
|
-
##### 2.3.2 反向对照:库内文档 → 接口规格说明一致性(5分)
|
|
218
|
-
|
|
219
|
-
| 检查项 | 验证方法 | 扣分规则 |
|
|
220
|
-
|--------|----------|----------|
|
|
221
|
-
| 文档接口存在性 | 库内文档描述的每个接口,在接口规格说明中搜索是否有对应定义 | 描述了不存在的接口每处扣 2 分,上限 5 分 |
|
|
222
|
-
| 属性类型一致性 | 对比库内文档与接口规格说明中同一接口的属性类型(参数类型、返回值类型) | 类型不一致每处扣 1 分,上限 3 分 |
|
|
223
|
-
| 版本信息准确性 | 文档版本号 vs 接口规格说明中的版本信息 | 不一致扣 2 分 |
|
|
224
|
-
|
|
225
|
-
---
|
|
226
|
-
|
|
227
|
-
### Phase 3:鸿蒙化文档易读性检查(中等项,20分)
|
|
228
|
-
|
|
229
|
-
#### 3.1 文档结构易读性(中等项,10分)
|
|
230
|
-
|
|
231
|
-
| 检查项 | 要求 | 扣分规则 |
|
|
232
|
-
|--------|------|----------|
|
|
233
|
-
| 文档结构清晰 | 有清晰的章节划分 | 无章节划分扣 5 分 |
|
|
234
|
-
| 章节层次合理 | 章节层次不超过 3 级 | 超过扣 3 分 |
|
|
235
|
-
| 内容分段合理 | 每段内容不超过 10 行 | 超长扣 2 分 |
|
|
236
|
-
| 标题清晰准确 | 标题准确描述章节内容,章节编号连续 | 不准确扣 2 分,编号跳号扣 1 分 |
|
|
237
|
-
|
|
238
|
-
#### 3.2 文档语言易读性(中等项,10分)
|
|
239
|
-
|
|
240
|
-
| 检查项 | 要求 | 扣分规则 |
|
|
241
|
-
|--------|------|----------|
|
|
242
|
-
| 语言简洁明了 | 避冗长和复杂表达 | 冗长扣 3 分 |
|
|
243
|
-
| 术语使用正确 | 使用标准技术术语 | 不标准扣 2 分 |
|
|
244
|
-
| 中英文恰当 | 技术名词可保留英文,但表格列名等应中英一致 | 混用不一致扣 2 分 |
|
|
245
|
-
| 错别字检查 | 无错别字(含繁简混用)和语法错误 | 有错误扣 2 分/处 |
|
|
246
|
-
|
|
247
|
-
---
|
|
248
|
-
|
|
249
|
-
### Phase 4:鸿蒙化示例文档检查(轻微项,10分)
|
|
250
|
-
|
|
251
|
-
#### 4.1 鸿蒙化示例完整性(轻微项,6分)
|
|
252
|
-
|
|
253
|
-
| 检查项 | 要求 | 扣分规则 |
|
|
254
|
-
|--------|------|----------|
|
|
255
|
-
| 鸿蒙示例存在 | 文档提供鸿蒙化相关示例 | 缺失扣 4 分 |
|
|
256
|
-
| 示例覆盖核心功能 | 示例覆盖主要鸿蒙化功能(≥2个不同功能场景) | 仅1个基础示例扣 2 分 |
|
|
257
|
-
| 示例可直接运行 | 示例代码可直接复制运行(或仅需替换资源路径) | 需大量额外准备扣 1 分,不可运行扣 2 分 |
|
|
258
|
-
|
|
259
|
-
#### 4.2 鸿蒙化示例注释(轻微项,4分)
|
|
260
|
-
|
|
261
|
-
| 检查项 | 要求 | 扣分规则 |
|
|
262
|
-
|--------|------|----------|
|
|
263
|
-
| 关键代码注释 | 关键鸿蒙化代码有注释 | 缺失扣 2 分 |
|
|
264
|
-
| 注释准确性 | 注释内容准确说明鸿蒙特性 | 不准确扣 2 分 |
|
|
265
|
-
|
|
266
|
-
---
|
|
267
|
-
|
|
268
|
-
### Phase 5:严苛评分计算
|
|
269
|
-
|
|
270
|
-
#### 评分维度权重
|
|
271
|
-
|
|
272
|
-
```
|
|
273
|
-
总分 = 鸿蒙文档完整性(40) + 接口说明准确性(30) + 文档易读性(20) + 鸿蒙示例(10)
|
|
274
|
-
```
|
|
275
|
-
|
|
276
|
-
#### 严苛扣分规则
|
|
277
|
-
|
|
278
|
-
```
|
|
279
|
-
致命问题(直接严重扣分):
|
|
280
|
-
- 缺少 README.OpenHarmony.md 等鸿蒙专属文档 → -15 分
|
|
281
|
-
- 缺少 Flutter 版本对应关系说明 → -10 分
|
|
282
|
-
- 鸕蒙化接口说明完全缺失 → -8 分
|
|
283
|
-
- 三方库调用方式说明缺失 → -10 分
|
|
284
|
-
- 鸕蒙文档内容为空或仅占位符 → -10 分(特殊:直接0分)
|
|
285
|
-
|
|
286
|
-
严重问题(仅当鸿蒙专属文档不存在时适用):
|
|
287
|
-
- README.md 无鸿蒙平台支持说明 → -10 分(⚠️ 当专属文档存在时不扣此分)
|
|
288
|
-
- 鸕蒙化接口列表缺失 → -8 分
|
|
289
|
-
- 鸕蒙安装配置说明缺失 → -8 分
|
|
290
|
-
- OHOS 环境配置步骤缺失 → -5 分
|
|
291
|
-
|
|
292
|
-
中等问题:
|
|
293
|
-
- 文档结构不清晰 → -3~5 分
|
|
294
|
-
- 鸕蒙化内容描述冗长 → -3 分
|
|
295
|
-
- 版本对应表缺少关键维度列 → -5 分
|
|
296
|
-
- 接口参数说明不完整 → -3~5 分
|
|
297
|
-
|
|
298
|
-
轻微问题:
|
|
299
|
-
- 鸕蒙示例不完整 → -2~4 分
|
|
300
|
-
- 示例注释缺失 → -2 分
|
|
301
|
-
- 错别字(含繁简混用) → -2 分/处
|
|
302
|
-
- 章节编号跳号 → -1 分
|
|
303
|
-
|
|
304
|
-
特殊规则(直接 0 分):
|
|
305
|
-
- 未发现任何鸿蒙化相关文档 → 0 分
|
|
306
|
-
- 鸕蒙文档完全为空或仅占位符 → 0 分
|
|
307
|
-
- 累计扣分超过 50 分 → 最低 0 分
|
|
308
|
-
```
|
|
309
|
-
|
|
310
|
-
#### 最终评分公式
|
|
311
|
-
|
|
312
|
-
```
|
|
313
|
-
基础分数:100 分
|
|
314
|
-
扣分合计:各维度扣分累加
|
|
315
|
-
最终得分 = max(0, 100 - 扣分合计)
|
|
316
|
-
```
|
|
317
|
-
|
|
318
|
-
---
|
|
319
|
-
|
|
320
|
-
## 输出格式
|
|
321
|
-
|
|
322
|
-
报告必须包含评分信息,格式如下(确保符合 `_parseFlutterLibraryScore` 解析函数要求):
|
|
323
|
-
|
|
324
|
-
```markdown
|
|
325
|
-
# {repoName} 文档质量检视报告
|
|
326
|
-
|
|
327
|
-
## 🔍 鸕蒙化文档定位结果
|
|
328
|
-
|
|
329
|
-
通过智能搜索定位到以下鸿蒙化相关文档:
|
|
330
|
-
|
|
331
|
-
| 文档类型 | 文件路径 | 状态 |
|
|
332
|
-
|----------|----------|------|
|
|
333
|
-
| 鸕蒙专属文档(英文) | README.OpenHarmony.md | ✅ 存在 |
|
|
334
|
-
| 鸕蒙专属文档(中文) | README.OpenHarmony_CN.md | ✅ 存在 |
|
|
335
|
-
| 鸕蒙专属文档(包级详细版) | kraken/README.OpenHarmony.md | ✅ 存在 |
|
|
336
|
-
| 上游原始 README | README.md | ⬜ 非鸿蒙文档,不检视不扣分 |
|
|
337
|
-
| CHANGELOG 鸕蒙变更 | CHANGELOG.md | ⚠️ 缺失鸿蒙变更记录 |
|
|
338
|
-
|
|
339
|
-
---
|
|
340
|
-
|
|
341
|
-
## 📊 文档质量检视评分
|
|
342
|
-
|
|
343
|
-
**综合评分:86/100**
|
|
344
|
-
|
|
345
|
-
| 维度 | 满分 | 得分 | 扣分详情 |
|
|
346
|
-
|------|------|------|----------|
|
|
347
|
-
| 鸕蒙文档完整性 | 40 | 35 | 版本对应表缺少关键维度列 -5 |
|
|
348
|
-
| 接口说明准确性 | 30 | 27 | 接口参数说明不够详细 -3 |
|
|
349
|
-
| 文档易读性 | 20 | 17 | 章节跳号 -1,中英文混用 -2 |
|
|
350
|
-
| 鸕蒙示例 | 10 | 7 | 示例覆盖不完整 -2,不可直接运行 -1 |
|
|
351
|
-
| **总计** | **100** | **86** | 累计扣分 14 分 |
|
|
352
|
-
|
|
353
|
-
---
|
|
354
|
-
|
|
355
|
-
## 🔍 详细检视结果
|
|
356
|
-
|
|
357
|
-
### 1. 鸕蒙化文档完整性检查
|
|
358
|
-
|
|
359
|
-
#### 1.1 鸕蒙专属文档检查(15分 → 15分)
|
|
360
|
-
- ✅ README.OpenHarmony.md 存在(根目录简版 + 包级详细版)
|
|
361
|
-
- ✅ 文档位置和命名规范
|
|
362
|
-
|
|
363
|
-
#### 1.2 README.md 鸕蒙章节(15分 → 15分)
|
|
364
|
-
- ⬜ 鸕蒙专属文档已存在,README.md 为上游原始文档,不纳入鸿蒙化扣分
|
|
365
|
-
|
|
366
|
-
#### 1.3 Flutter 版本对应关系说明(10分 → 5分)
|
|
367
|
-
- ⚠️ 版本对应表仅一行(当前版本),缺少关键维度列
|
|
368
|
-
|
|
369
|
-
### 2. 鸕蒙化接口说明准确性检查
|
|
370
|
-
...
|
|
371
|
-
|
|
372
|
-
### 3. 文档易读性检查
|
|
373
|
-
...
|
|
374
|
-
|
|
375
|
-
### 4. 鸕蒙化示例检查
|
|
376
|
-
...
|
|
377
|
-
|
|
378
|
-
---
|
|
379
|
-
|
|
380
|
-
## 💡 改进建议
|
|
381
|
-
|
|
382
|
-
1. **扩充版本对应表**:建议补充关键维度列(如 Flutter 框架版本、TAG、分支)
|
|
383
|
-
2. **完善接口参数说明**:建议补充参数默认值、必填/可选标记
|
|
384
|
-
3. **增加更多功能示例**:建议补充多个核心功能场景示例
|
|
385
|
-
4. **修复错别字**:中文版 "未經" → "未经"
|
|
386
|
-
```
|
|
387
|
-
|
|
388
|
-
---
|
|
389
|
-
|
|
390
|
-
## 检视清单
|
|
391
|
-
|
|
392
|
-
详细检查项参见 [references/CHECKLIST.md](references/CHECKLIST.md)
|
|
393
|
-
|
|
394
|
-
---
|
|
395
|
-
|
|
396
|
-
## 输出要求
|
|
397
|
-
|
|
398
|
-
1. **评分格式必须符合解析函数要求**:
|
|
399
|
-
- 首选格式:`**综合评分:XX/100**`(中文冒号,加粗格式)
|
|
400
|
-
- 兼容格式:`【总体评分】:XX/100`、`**评分**:XX/100`、`评分:XX/100`
|
|
401
|
-
- 评分必须是 0-100 的整数
|
|
402
|
-
2. **报告必须列出鸿蒙化文档定位结果**:包括搜索到的文档类型、文件路径、状态;上游原始 README.md 应标注"⬜ 非鸿蒙文档,不检视不扣分"
|
|
403
|
-
3. **报告需详细说明扣分原因**:明确标注扣分项、扣分值、改进建议
|
|
404
|
-
4. **1.2 节必须明确标注场景**:当专属文档存在时写"⬜ 专属文档已存在,README.md 不纳入鸿蒙化扣分"
|
|
405
|
-
5. **使用中文撰写内容**:确保易读性
|
|
406
|
-
6. **核心关注鸿蒙化内容**:不检视非鸿蒙化部分的文档,不因上游 README.md 缺少鸿蒙内容而扣分
|
|
1
|
+
---
|
|
2
|
+
name: flutter-library-documentation-quality-check
|
|
3
|
+
description: 对 Flutter 三方库的**鸿蒙化代码相关文档**进行文档质量检视,核心检视 README.OpenHarmony.md 等鸿蒙化专属文档(而非上游原始 README.md),评估鸿蒙化文档的完整性、准确性、易读性,特别关注鸿蒙化接口说明、三方库调用方式、Flutter版本对应关系等关键内容,生成严苛评分报告(0-100分)。作为 Flutter 仓库检视流程的第六阶段,依赖内存泄露检视结果。
|
|
4
|
+
license: Apache-2.0
|
|
5
|
+
compatibility: 需要访问 Git 仓库、智能识别鸿蒙化相关文档、分析文档内容
|
|
6
|
+
metadata:
|
|
7
|
+
author: CPPAgent
|
|
8
|
+
version: "3.0"
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# FlutterLibraryDocumentationQualityCheckSkill
|
|
12
|
+
|
|
13
|
+
对 Flutter 三方库的**鸿蒙化代码相关文档**进行文档质量检视,评估鸿蒙化文档的完整性、准确性、易读性,特别关注鸿蒙化接口说明、三方库调用方式、Flutter版本对应关系等关键内容。
|
|
14
|
+
|
|
15
|
+
> ⚠️ **核心定位**:本 SKILL **仅检视鸿蒙化代码相关文档**,不关注非鸿蒙化部分的文档。检视核心是 README.OpenHarmony.md 等鸿蒙专属文档。**上游原始 README.md 不纳入鸿蒙化检视评分**——很多仓库的 README.md 是上游原始项目文档,鸿蒙化内容应正确放置在专属文档中,不因原始 README.md 缺少鸿蒙内容而扣分。通过**智能搜索识别鸿蒙化相关文档**,分析文档的完整性、准确性、易读性等方面。
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## 任务参数
|
|
20
|
+
|
|
21
|
+
| 参数 | 必需 | 说明 |
|
|
22
|
+
|------|------|------|
|
|
23
|
+
| `repoUrl` | ✅ | Git 仓库地址,支持分支 `?branch=xxx` |
|
|
24
|
+
| `outputDir` | ✅ | 输出目录绝对路径,存放检视报告 |
|
|
25
|
+
| `interfaceDocPath` | ✅ | 接口规格说明文档路径(用于准确性交叉验证) |
|
|
26
|
+
| `repoName` | ✅ | 仓库名称(用于报告标识) |
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## 输入依赖
|
|
31
|
+
|
|
32
|
+
本 SKILL 是 Flutter 仓库检视流程的**第六阶段**,依赖:
|
|
33
|
+
|
|
34
|
+
- **前置 SKILL**: `flutter-library-memory-leak-check`
|
|
35
|
+
- **输入文件**: `接口规格说明.md`、`内存泄露检视报告.md`
|
|
36
|
+
- **仓库源码**: 已克隆到 `{outputDir}/source/`
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## 工作流程
|
|
41
|
+
|
|
42
|
+
### Phase 0:鸿蒙化相关文档智能定位
|
|
43
|
+
|
|
44
|
+
**通过多维度搜索策略**,智能识别鸿蒙化相关文档,而非检视所有文档。
|
|
45
|
+
|
|
46
|
+
#### 0.1 鸿蒙化文档搜索策略(优先级递减)
|
|
47
|
+
|
|
48
|
+
| 搜索维度 | 文件特征 | 权重 | 说明 |
|
|
49
|
+
|----------|----------|------|------|
|
|
50
|
+
| **鸿蒙专属文档** | `README.OpenHarmony.md`、`README.OpenHarmony_CN.md`、`README.openharmony.md`、`README.harmony.md`、`README.ohos.md` 及包级子目录同名文件 | ⭐⭐⭐⭐ 最高 | 鸿蒙化专属文档,是检视核心 |
|
|
51
|
+
| **README 鸿蒙章节** | 根/包 README.md 中包含 "ohos"、"harmony"、"openharmony"、"鸿蒙" 等关键词 | ⭐⭐⭐ 高 | 仅当**不存在鸿蒙专属文档时**才检视 |
|
|
52
|
+
| **鸿蒙配置文档** | `oh-package.json5`、`module.json5`、`build-profile.json5` | ⭐⭐ 中 | 鸿蒙模块配置(辅助参考) |
|
|
53
|
+
| **API 文档鸿蒙部分** | API 文档中包含鸿蒙化接口说明 | ⭐⭐ 中 | API 文档的鸿蒙化内容 |
|
|
54
|
+
| **示例文档鸿蒙部分** | example 目录中的鸿蒙化示例说明 | ⭐ 低 | 示例文档的鸿蒙化内容 |
|
|
55
|
+
|
|
56
|
+
#### 0.2 搜索执行流程
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
# Step 1: 搜索鸿蒙特定 README 文件(最高优先级)
|
|
60
|
+
# 注意:使用通配符匹配大小写变体和语言后缀变体(_CN, _zh 等)
|
|
61
|
+
find {sourceDir} -iname "README.*harmony*" -o -iname "README.*ohos*" -o -iname "README.*openharmony*" -type f
|
|
62
|
+
|
|
63
|
+
# Step 2: 同时检查根目录和包级子目录(如 kraken/, lib/ 等)
|
|
64
|
+
# Flutter 项目常见结构:根目录简版 + 包级详细版
|
|
65
|
+
find {sourceDir} -maxdepth 2 -iname "README.*harmony*" -o -iname "README.*ohos*" -o -iname "README.*openharmony*" -type f
|
|
66
|
+
|
|
67
|
+
# Step 3: 若未发现鸿蒙专属文档,才搜索 README.md 中的鸿蒙章节
|
|
68
|
+
grep -n -i "ohos|harmony|openharmony|鸿蒙|harmonyos" {sourceDir}/README.md
|
|
69
|
+
|
|
70
|
+
# Step 4: 搜索 CHANGELOG.md 中的鸿蒙化变更记录
|
|
71
|
+
find {sourceDir} -name "CHANGELOG.md" -type f | xargs grep -l -i "ohos|harmony|openharmony|鸿蒙|harmonyos"
|
|
72
|
+
|
|
73
|
+
# Step 5: 搜索 example 目录中的鸿蒙化示例说明
|
|
74
|
+
find {sourceDir} -path "*/example/*" -name "README.md" -type f | xargs grep -l -i "ohos|harmony|openharmony|鸿蒙"
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
#### 0.3 鸿蒙化文档定位结果分类
|
|
78
|
+
|
|
79
|
+
根据搜索结果,将文档分为以下类别:
|
|
80
|
+
|
|
81
|
+
```
|
|
82
|
+
检视范围判定:
|
|
83
|
+
├── 鸿蒙核心文档(必检视)
|
|
84
|
+
│ ├── README.OpenHarmony.md / README.openharmony.md ✅ 检视(最高优先级)
|
|
85
|
+
│ ├── README.OpenHarmony_CN.md / 中文变体 ✅ 检视(最高优先级)
|
|
86
|
+
│ ├── README.harmony.md ✅ 检视(最高优先级)
|
|
87
|
+
│ ├── README.ohos.md ✅ 检视(最高优先级)
|
|
88
|
+
│ ├── 包级子目录同名文件(如 kraken/README.OpenHarmony.md)✅ 检视(最高优先级)
|
|
89
|
+
│ ├── CHANGELOG.md 鸿蒙变更 ✅ 检视
|
|
90
|
+
│ └── API 文档鸿蒙接口说明 ✅ 检视
|
|
91
|
+
├── 鸿蒙替代文档(仅当专属文档不存在时检视)
|
|
92
|
+
│ └── README.md 鸿蒙章节 ⚠️ 替代检视(专属文档缺失时)
|
|
93
|
+
├── 鸿蒙辅助文档(辅助检视)
|
|
94
|
+
│ ├── oh-package.json5 说明 ⚠️ 辅助参考
|
|
95
|
+
│ ├── module.json5 说明 ⚠️ 辅助参考
|
|
96
|
+
│ └── example 鸿蒙示例 ⚠️ 辅助参考
|
|
97
|
+
├── 非鸿蒙文档(不检视,不扣分)
|
|
98
|
+
│ ├── README.md 上游原始内容 ❌ 不检视、不扣分(如 Android/iOS 说明)
|
|
99
|
+
│ ├── CHANGELOG.md 其他变更 ❌ 不检视
|
|
100
|
+
│ ├── API 文档非鸿蒙接口 ❌ 不检视
|
|
101
|
+
│ └── example 其他平台示例 ❌ 不检视
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
#### 0.4 判定规则
|
|
105
|
+
|
|
106
|
+
| 搜索结果 | 判定 | 评分 | 后续操作 |
|
|
107
|
+
|----------|------|------|----------|
|
|
108
|
+
| 发现 `README.OpenHarmony.md` 等(含 `_CN` 变体、包级文件) | ✅ 存在鸿蒙专属文档 | 正常评分 | 进入 Phase 1 深度检视,**README.md 不纳入鸿蒙化扣分** |
|
|
109
|
+
| 仅 README.md 包含鸿蒙章节(无专属文档) | ⚠️ 缺少专属文档 | 正常评分但1.1扣15分 | 进入 Phase 1,检视 README.md 鸿蒙章节替代专属文档 |
|
|
110
|
+
| 仅发现配置文件无说明文档 | ⚠️ 文档缺失严重 | 20-40 分 | 报告标注"鸿蒙化文档严重缺失" |
|
|
111
|
+
| 未发现任何鸿蒙文档特征 | ❌ 鸿蒙化文档缺失 | **0 分** | 报告标注"未发现鸿蒙化相关文档" |
|
|
112
|
+
| 无法访问源码目录 | ❌ 无法检视 | **0 分** | 报告标注"源码目录不可访问" |
|
|
113
|
+
|
|
114
|
+
**重要说明**:
|
|
115
|
+
- **上游 README.md 不扣分**:README.md 通常是上游原始项目文档,鸿蒙化内容应放在 README.OpenHarmony.md 等专属文档中。**当专属文档存在时,README.md 缺少鸿蒙内容不扣分**
|
|
116
|
+
- **专属文档优先**:README.OpenHarmony.md 等鸿蒙专属文档是检视核心,缺失将严重扣分
|
|
117
|
+
- **多层级文档**:根目录简版 + 包级详细版 是常见的合理结构,两者均需检视
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
### Phase 1:鸿蒙化文档完整性检查(致命项,40分)
|
|
122
|
+
|
|
123
|
+
#### 1.1 鸿蒙专属文档存在性检查(致命项,15分)
|
|
124
|
+
|
|
125
|
+
| 检查项 | 要求 | 扣分规则 |
|
|
126
|
+
|--------|------|----------|
|
|
127
|
+
| README.OpenHarmony.md 等存在 | 应有鸿蒙专属 README 文件(含 `_CN` 变体) | **缺失扣 15 分(致命)** |
|
|
128
|
+
| 鸿蒙文档位置正确 | 位于根目录、docs 目录或包级子目录 | 位置不当扣 3 分 |
|
|
129
|
+
| 鸿蒙文档命名规范 | 使用标准命名格式(大小写不扣分) | 命名不规范扣 2 分(大小写不扣分) |
|
|
130
|
+
| 鸿蒙文档内容非空 | 文档内容不为空或仅占位符 | 为空扣 10 分 |
|
|
131
|
+
|
|
132
|
+
#### 1.2 README.md 鸿蒙章节完整性(严苛项,15分)
|
|
133
|
+
|
|
134
|
+
**关键规则**:本节仅在**不存在鸿蒙专属文档时**启用。当 README.OpenHarmony.md 等专属文档存在时,README.md 作为上游原始文档,其缺少鸿蒙内容**不扣分**,本节直接满分 15 分。
|
|
135
|
+
|
|
136
|
+
**场景 A:鸿蒙专属文档存在 → 本节满分 15/15,无需检视 README.md 鸿蒙章节**
|
|
137
|
+
|
|
138
|
+
**场景 B:鸿蒙专属文档不存在 → 检视 README.md 鸿蒙章节替代专属文档**:
|
|
139
|
+
|
|
140
|
+
| 检查项 | 要求 | 扣分规则 |
|
|
141
|
+
|--------|------|----------|
|
|
142
|
+
| 鸿蒙平台支持说明 | README.md 明确说明支持鸿蒙/OpenHarmony 平台 | **缺失扣 10 分** |
|
|
143
|
+
| 鸿蒙安装配置说明 | README.md 提供鸿蒙平台的安装和配置步骤 | 缺失扣 8 分 |
|
|
144
|
+
| 鸿蒙平台差异说明 | README.md 说明鸿蒙平台与其他平台的差异 | 缺失扣 5 分 |
|
|
145
|
+
| 鸿蒙版本要求说明 | README.md 说明鸿蒙系统版本要求 | 缺失扣 5 分 |
|
|
146
|
+
|
|
147
|
+
#### 1.3 Flutter 版本对应关系说明(致命项,10分)
|
|
148
|
+
|
|
149
|
+
**这是用户明确要求的核心检查项**:
|
|
150
|
+
|
|
151
|
+
| 检查项 | 要求 | 扣分规则 |
|
|
152
|
+
|--------|------|----------|
|
|
153
|
+
| Flutter 版本对应说明 | 清晰说明 Flutter 框架版本与三方库版本对应关系 | **缺失扣 10 分(致命)** |
|
|
154
|
+
| 版本对应表完整 | 提供版本对应表,包含关键维度列 | 缺少关键列扣 5 分 |
|
|
155
|
+
| 版本兼容性说明 | 说明版本兼容性和不兼容情况 | 缺失扣 3 分 |
|
|
156
|
+
| 升级迁移说明 | 说明版本升级的迁移方法 | 缺失扣 2 分 |
|
|
157
|
+
|
|
158
|
+
**版本对应表完整性判定**:
|
|
159
|
+
|
|
160
|
+
| 情况 | 判定 | 扣分 |
|
|
161
|
+
|------|------|------|
|
|
162
|
+
| 表格仅有当前版本一行数据(新适配库常见) | ✅ 合理完整 | **0 分** |
|
|
163
|
+
| 表格缺少关键维度列(如缺少 Flutter 框架版本列、TAG 列、分支列) | ⚠️ 不完整 | -5 分 |
|
|
164
|
+
| 表格信息与接口规格说明不一致 | ⚠️ 不准确 | -3 分 |
|
|
165
|
+
| 完全无版本对应表 | ❌ 致命缺失 | -10 分 |
|
|
166
|
+
|
|
167
|
+
**版本对应说明示例**:
|
|
168
|
+
|
|
169
|
+
```markdown
|
|
170
|
+
### TAG 版本对应表
|
|
171
|
+
|
|
172
|
+
| Flutter 框架版本 | TAG | 分支 |
|
|
173
|
+
|-----------------|-----|------|
|
|
174
|
+
| 3.22 | 4.2.3-ohos-1.0.0-beta.1 | br_3.27 |
|
|
175
|
+
| 3.27 | 4.2.3-ohos-1.0.0-beta.1 | br_3.27 |
|
|
176
|
+
| 3.35 | 4.2.3-ohos-1.0.0-beta.1 | br_3.27 |
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
---
|
|
180
|
+
|
|
181
|
+
### Phase 2:鸿蒙化接口说明准确性检查(严苛项,30分)
|
|
182
|
+
|
|
183
|
+
> ⚠️ **准确性交叉验证**:本 Phase 要求**读取 `{interfaceDocPath}`(接口规格说明.md)**,将文档中的 API 名称、参数类型、版本信息与接口规格说明进行对比,确保文档描述与实际实现一致。
|
|
184
|
+
|
|
185
|
+
#### 2.1 鸿蒙化接口说明完整性(严苛项,10分)
|
|
186
|
+
|
|
187
|
+
**这是用户明确要求的核心检查项**:
|
|
188
|
+
|
|
189
|
+
| 检查项 | 要求 | 扣分规则 |
|
|
190
|
+
|--------|------|----------|
|
|
191
|
+
| 鸿蒙化接口列表 | 文档列出所有鸿蒙化实现的接口,标注 OHOS 支持状态 | **缺失扣 6 分** |
|
|
192
|
+
| 接口功能说明 | 每个鸿蒙化接口有清晰的功能说明 | 缺失扣 3 分 |
|
|
193
|
+
| 接口使用示例 | 提供接口使用示例代码 | 缺失扣 2 分 |
|
|
194
|
+
|
|
195
|
+
#### 2.2 三方库调用方式说明(严苛项,10分)
|
|
196
|
+
|
|
197
|
+
**这是用户明确要求的核心检查项**:
|
|
198
|
+
|
|
199
|
+
| 检查项 | 要求 | 扣分规则 |
|
|
200
|
+
|--------|------|----------|
|
|
201
|
+
| 调用方式说明 | 清晰说明三方库的调用方式(依赖添加 → 导入 → 创建 → 使用) | **缺失扣 10 分** |
|
|
202
|
+
| OHOS 环境配置步骤 | 提供详细的 OHOS 开发环境配置步骤(DevEco、SDK、编译) | 缺失扣 5 分 |
|
|
203
|
+
| 调用示例代码 | 提供完整的调用示例代码 | 缺失扣 5 分 |
|
|
204
|
+
|
|
205
|
+
#### 2.3 接口文档与库内文档双向对照(致命项,10分)
|
|
206
|
+
|
|
207
|
+
> ⚠️ **双向对照核心机制**:从接口规格说明出发验证库内文档覆盖度(正向),从库内文档出发验证接口规格说明一致性(反向),确保双向一致。
|
|
208
|
+
|
|
209
|
+
##### 2.3.1 正向对照:接口规格说明 → 库内文档覆盖度(5分)
|
|
210
|
+
|
|
211
|
+
| 检查项 | 验证方法 | 扣分规则 |
|
|
212
|
+
|--------|----------|----------|
|
|
213
|
+
| 接口覆盖完整性 | 读取接口规格说明中列出的每个接口,在库内文档中搜索是否均有描述 | 覆盖率 <80% 扣 3 分,<50% 扣 5 分 |
|
|
214
|
+
| 关键属性覆盖 | 检查库内文档是否描述了接口规格说明中的关键属性(参数列表、返回值、异常说明) | 遗漏关键属性每项扣 1 分,上限 3 分 |
|
|
215
|
+
| 参数说明对照 | 对比接口规格说明中每个接口的参数(名称、类型、可选/必填),与库内文档描述是否一致 | 不一致每处扣 1 分,上限 3 分 |
|
|
216
|
+
|
|
217
|
+
##### 2.3.2 反向对照:库内文档 → 接口规格说明一致性(5分)
|
|
218
|
+
|
|
219
|
+
| 检查项 | 验证方法 | 扣分规则 |
|
|
220
|
+
|--------|----------|----------|
|
|
221
|
+
| 文档接口存在性 | 库内文档描述的每个接口,在接口规格说明中搜索是否有对应定义 | 描述了不存在的接口每处扣 2 分,上限 5 分 |
|
|
222
|
+
| 属性类型一致性 | 对比库内文档与接口规格说明中同一接口的属性类型(参数类型、返回值类型) | 类型不一致每处扣 1 分,上限 3 分 |
|
|
223
|
+
| 版本信息准确性 | 文档版本号 vs 接口规格说明中的版本信息 | 不一致扣 2 分 |
|
|
224
|
+
|
|
225
|
+
---
|
|
226
|
+
|
|
227
|
+
### Phase 3:鸿蒙化文档易读性检查(中等项,20分)
|
|
228
|
+
|
|
229
|
+
#### 3.1 文档结构易读性(中等项,10分)
|
|
230
|
+
|
|
231
|
+
| 检查项 | 要求 | 扣分规则 |
|
|
232
|
+
|--------|------|----------|
|
|
233
|
+
| 文档结构清晰 | 有清晰的章节划分 | 无章节划分扣 5 分 |
|
|
234
|
+
| 章节层次合理 | 章节层次不超过 3 级 | 超过扣 3 分 |
|
|
235
|
+
| 内容分段合理 | 每段内容不超过 10 行 | 超长扣 2 分 |
|
|
236
|
+
| 标题清晰准确 | 标题准确描述章节内容,章节编号连续 | 不准确扣 2 分,编号跳号扣 1 分 |
|
|
237
|
+
|
|
238
|
+
#### 3.2 文档语言易读性(中等项,10分)
|
|
239
|
+
|
|
240
|
+
| 检查项 | 要求 | 扣分规则 |
|
|
241
|
+
|--------|------|----------|
|
|
242
|
+
| 语言简洁明了 | 避冗长和复杂表达 | 冗长扣 3 分 |
|
|
243
|
+
| 术语使用正确 | 使用标准技术术语 | 不标准扣 2 分 |
|
|
244
|
+
| 中英文恰当 | 技术名词可保留英文,但表格列名等应中英一致 | 混用不一致扣 2 分 |
|
|
245
|
+
| 错别字检查 | 无错别字(含繁简混用)和语法错误 | 有错误扣 2 分/处 |
|
|
246
|
+
|
|
247
|
+
---
|
|
248
|
+
|
|
249
|
+
### Phase 4:鸿蒙化示例文档检查(轻微项,10分)
|
|
250
|
+
|
|
251
|
+
#### 4.1 鸿蒙化示例完整性(轻微项,6分)
|
|
252
|
+
|
|
253
|
+
| 检查项 | 要求 | 扣分规则 |
|
|
254
|
+
|--------|------|----------|
|
|
255
|
+
| 鸿蒙示例存在 | 文档提供鸿蒙化相关示例 | 缺失扣 4 分 |
|
|
256
|
+
| 示例覆盖核心功能 | 示例覆盖主要鸿蒙化功能(≥2个不同功能场景) | 仅1个基础示例扣 2 分 |
|
|
257
|
+
| 示例可直接运行 | 示例代码可直接复制运行(或仅需替换资源路径) | 需大量额外准备扣 1 分,不可运行扣 2 分 |
|
|
258
|
+
|
|
259
|
+
#### 4.2 鸿蒙化示例注释(轻微项,4分)
|
|
260
|
+
|
|
261
|
+
| 检查项 | 要求 | 扣分规则 |
|
|
262
|
+
|--------|------|----------|
|
|
263
|
+
| 关键代码注释 | 关键鸿蒙化代码有注释 | 缺失扣 2 分 |
|
|
264
|
+
| 注释准确性 | 注释内容准确说明鸿蒙特性 | 不准确扣 2 分 |
|
|
265
|
+
|
|
266
|
+
---
|
|
267
|
+
|
|
268
|
+
### Phase 5:严苛评分计算
|
|
269
|
+
|
|
270
|
+
#### 评分维度权重
|
|
271
|
+
|
|
272
|
+
```
|
|
273
|
+
总分 = 鸿蒙文档完整性(40) + 接口说明准确性(30) + 文档易读性(20) + 鸿蒙示例(10)
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
#### 严苛扣分规则
|
|
277
|
+
|
|
278
|
+
```
|
|
279
|
+
致命问题(直接严重扣分):
|
|
280
|
+
- 缺少 README.OpenHarmony.md 等鸿蒙专属文档 → -15 分
|
|
281
|
+
- 缺少 Flutter 版本对应关系说明 → -10 分
|
|
282
|
+
- 鸕蒙化接口说明完全缺失 → -8 分
|
|
283
|
+
- 三方库调用方式说明缺失 → -10 分
|
|
284
|
+
- 鸕蒙文档内容为空或仅占位符 → -10 分(特殊:直接0分)
|
|
285
|
+
|
|
286
|
+
严重问题(仅当鸿蒙专属文档不存在时适用):
|
|
287
|
+
- README.md 无鸿蒙平台支持说明 → -10 分(⚠️ 当专属文档存在时不扣此分)
|
|
288
|
+
- 鸕蒙化接口列表缺失 → -8 分
|
|
289
|
+
- 鸕蒙安装配置说明缺失 → -8 分
|
|
290
|
+
- OHOS 环境配置步骤缺失 → -5 分
|
|
291
|
+
|
|
292
|
+
中等问题:
|
|
293
|
+
- 文档结构不清晰 → -3~5 分
|
|
294
|
+
- 鸕蒙化内容描述冗长 → -3 分
|
|
295
|
+
- 版本对应表缺少关键维度列 → -5 分
|
|
296
|
+
- 接口参数说明不完整 → -3~5 分
|
|
297
|
+
|
|
298
|
+
轻微问题:
|
|
299
|
+
- 鸕蒙示例不完整 → -2~4 分
|
|
300
|
+
- 示例注释缺失 → -2 分
|
|
301
|
+
- 错别字(含繁简混用) → -2 分/处
|
|
302
|
+
- 章节编号跳号 → -1 分
|
|
303
|
+
|
|
304
|
+
特殊规则(直接 0 分):
|
|
305
|
+
- 未发现任何鸿蒙化相关文档 → 0 分
|
|
306
|
+
- 鸕蒙文档完全为空或仅占位符 → 0 分
|
|
307
|
+
- 累计扣分超过 50 分 → 最低 0 分
|
|
308
|
+
```
|
|
309
|
+
|
|
310
|
+
#### 最终评分公式
|
|
311
|
+
|
|
312
|
+
```
|
|
313
|
+
基础分数:100 分
|
|
314
|
+
扣分合计:各维度扣分累加
|
|
315
|
+
最终得分 = max(0, 100 - 扣分合计)
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
---
|
|
319
|
+
|
|
320
|
+
## 输出格式
|
|
321
|
+
|
|
322
|
+
报告必须包含评分信息,格式如下(确保符合 `_parseFlutterLibraryScore` 解析函数要求):
|
|
323
|
+
|
|
324
|
+
```markdown
|
|
325
|
+
# {repoName} 文档质量检视报告
|
|
326
|
+
|
|
327
|
+
## 🔍 鸕蒙化文档定位结果
|
|
328
|
+
|
|
329
|
+
通过智能搜索定位到以下鸿蒙化相关文档:
|
|
330
|
+
|
|
331
|
+
| 文档类型 | 文件路径 | 状态 |
|
|
332
|
+
|----------|----------|------|
|
|
333
|
+
| 鸕蒙专属文档(英文) | README.OpenHarmony.md | ✅ 存在 |
|
|
334
|
+
| 鸕蒙专属文档(中文) | README.OpenHarmony_CN.md | ✅ 存在 |
|
|
335
|
+
| 鸕蒙专属文档(包级详细版) | kraken/README.OpenHarmony.md | ✅ 存在 |
|
|
336
|
+
| 上游原始 README | README.md | ⬜ 非鸿蒙文档,不检视不扣分 |
|
|
337
|
+
| CHANGELOG 鸕蒙变更 | CHANGELOG.md | ⚠️ 缺失鸿蒙变更记录 |
|
|
338
|
+
|
|
339
|
+
---
|
|
340
|
+
|
|
341
|
+
## 📊 文档质量检视评分
|
|
342
|
+
|
|
343
|
+
**综合评分:86/100**
|
|
344
|
+
|
|
345
|
+
| 维度 | 满分 | 得分 | 扣分详情 |
|
|
346
|
+
|------|------|------|----------|
|
|
347
|
+
| 鸕蒙文档完整性 | 40 | 35 | 版本对应表缺少关键维度列 -5 |
|
|
348
|
+
| 接口说明准确性 | 30 | 27 | 接口参数说明不够详细 -3 |
|
|
349
|
+
| 文档易读性 | 20 | 17 | 章节跳号 -1,中英文混用 -2 |
|
|
350
|
+
| 鸕蒙示例 | 10 | 7 | 示例覆盖不完整 -2,不可直接运行 -1 |
|
|
351
|
+
| **总计** | **100** | **86** | 累计扣分 14 分 |
|
|
352
|
+
|
|
353
|
+
---
|
|
354
|
+
|
|
355
|
+
## 🔍 详细检视结果
|
|
356
|
+
|
|
357
|
+
### 1. 鸕蒙化文档完整性检查
|
|
358
|
+
|
|
359
|
+
#### 1.1 鸕蒙专属文档检查(15分 → 15分)
|
|
360
|
+
- ✅ README.OpenHarmony.md 存在(根目录简版 + 包级详细版)
|
|
361
|
+
- ✅ 文档位置和命名规范
|
|
362
|
+
|
|
363
|
+
#### 1.2 README.md 鸕蒙章节(15分 → 15分)
|
|
364
|
+
- ⬜ 鸕蒙专属文档已存在,README.md 为上游原始文档,不纳入鸿蒙化扣分
|
|
365
|
+
|
|
366
|
+
#### 1.3 Flutter 版本对应关系说明(10分 → 5分)
|
|
367
|
+
- ⚠️ 版本对应表仅一行(当前版本),缺少关键维度列
|
|
368
|
+
|
|
369
|
+
### 2. 鸕蒙化接口说明准确性检查
|
|
370
|
+
...
|
|
371
|
+
|
|
372
|
+
### 3. 文档易读性检查
|
|
373
|
+
...
|
|
374
|
+
|
|
375
|
+
### 4. 鸕蒙化示例检查
|
|
376
|
+
...
|
|
377
|
+
|
|
378
|
+
---
|
|
379
|
+
|
|
380
|
+
## 💡 改进建议
|
|
381
|
+
|
|
382
|
+
1. **扩充版本对应表**:建议补充关键维度列(如 Flutter 框架版本、TAG、分支)
|
|
383
|
+
2. **完善接口参数说明**:建议补充参数默认值、必填/可选标记
|
|
384
|
+
3. **增加更多功能示例**:建议补充多个核心功能场景示例
|
|
385
|
+
4. **修复错别字**:中文版 "未經" → "未经"
|
|
386
|
+
```
|
|
387
|
+
|
|
388
|
+
---
|
|
389
|
+
|
|
390
|
+
## 检视清单
|
|
391
|
+
|
|
392
|
+
详细检查项参见 [references/CHECKLIST.md](references/CHECKLIST.md)
|
|
393
|
+
|
|
394
|
+
---
|
|
395
|
+
|
|
396
|
+
## 输出要求
|
|
397
|
+
|
|
398
|
+
1. **评分格式必须符合解析函数要求**:
|
|
399
|
+
- 首选格式:`**综合评分:XX/100**`(中文冒号,加粗格式)
|
|
400
|
+
- 兼容格式:`【总体评分】:XX/100`、`**评分**:XX/100`、`评分:XX/100`
|
|
401
|
+
- 评分必须是 0-100 的整数
|
|
402
|
+
2. **报告必须列出鸿蒙化文档定位结果**:包括搜索到的文档类型、文件路径、状态;上游原始 README.md 应标注"⬜ 非鸿蒙文档,不检视不扣分"
|
|
403
|
+
3. **报告需详细说明扣分原因**:明确标注扣分项、扣分值、改进建议
|
|
404
|
+
4. **1.2 节必须明确标注场景**:当专属文档存在时写"⬜ 专属文档已存在,README.md 不纳入鸿蒙化扣分"
|
|
405
|
+
5. **使用中文撰写内容**:确保易读性
|
|
406
|
+
6. **核心关注鸿蒙化内容**:不检视非鸿蒙化部分的文档,不因上游 README.md 缺少鸿蒙内容而扣分
|
|
407
407
|
7. **准确性必须交叉验证**:必须读取 `接口规格说明.md` 并与文档内容对比
|