Skip to content

Latest commit

 

History

History

README.md

docs/README.md

本目录是 JavaSec 的规则正文索引(Single Source of Truth)。

推荐阅读顺序

  1. DESIGN.md:先理解仓库边界与目录落点。
  2. RELIABILITY.md:确认复现与记录的稳定性要求。
  3. SECURITY.md:了解安全边界与风险表达要求。
  4. QUALITY_SCORE.md:按统一标准做自检。
  5. PLANS.md:需要分阶段推进时使用。
  6. PRODUCT_SENSE.md:面向读者体验与内容行为约束。

主题文档

  • DESIGN.md:架构边界与信息分层。
  • RELIABILITY.md:可复现、可验证、可维护。
  • SECURITY.md:合法性、最小披露、风险提示。
  • PRODUCT_SENSE.md:学习路径与读者体验。
  • QUALITY_SCORE.md:提交前质量评分清单。
  • PLANS.md:任务拆解、里程碑与回顾。
  • FRONTEND.md:前端相关内容(当前仓库少量使用)。

子目录约定

  • design-docs/:深度设计附录。
  • exec-plans/:执行计划与技术债记录。
  • generated/:生成工件与自动化产物。
  • product-specs/:规格类文档。
  • references/:参考材料、历史记录、外部手册。