docs: introduce project-scaffold documentation skeleton - #9
Merged
Merged
Conversation
Adopt the language-agnostic doc governance scaffold: root-level entry
docs (AGENTS/ARCHITECTURE/DESIGN/PRODUCT_SENSE/FRONTEND/RELIABILITY/
SECURITY/QUALITY_SCORE/CHANGELOG), docs/{design-docs,product-specs,
references,generated}/ index, and rules/ for commit, validation,
doc-update, compatibility and parallel-collab conventions. Content is
filled in to match this project's actual shape (frontend-only Vite/
React, localStorage history, optional share endpoint) rather than left
as placeholders. README gains a Repo Map pointing at the new layout.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
project-scaffold的文档治理骨架,引入 json-tool 项目的稳定层文档与规则。Changes
AGENTS.md(协作入口与阅读顺序)、ARCHITECTURE.md(稳定层与不可破坏边界)、DESIGN.md(设计原则与长期约束)、PRODUCT_SENSE.md(用户与场景)、FRONTEND.md(前端设计语言与离线承诺)、RELIABILITY.md(降级/恢复/canonical scenarios)、SECURITY.md(信任边界与日志规范)、QUALITY_SCORE.md(质量维度与交付标准)、CHANGELOG.md。docs/:design-docs/index.md、product-specs/index.md、references/README.md、generated/.gitkeep,分离手写设计、产品视角、外部参考与生成产物。rules/:提交规范、文档更新策略、并行协作约定、公共接口兼容性、验证门禁。validation-gate.md已写入项目真实命令(pnpm install/build/test/preview、docker build/run)。README.md:补 Repo Map,指向新增文档结构,保留原有 Features/Stack/Development/Docker/CI/License 段落。Why
把"代码外、不会从代码读出来"的原则、边界、信任假设沉淀成可导航的文档骨架,让后续 AI/人类协作者在动手前有统一入口,并把"完成态"标准显式化(
rules/validation-gate.md)。Test plan
pnpm install(已为构建产物缓存)pnpm build— Vite 输出dist/,无类型错误pnpm test— 12 tests pass(historyStore / jsonUtils)pnpm dev主路径与 Docker 真实链路验证)🤖 Generated with Claude Code