1.4 KiB
1.4 KiB
写作与结构维护手册(Mycontent-book)
1. 你改文档,我怎么理解
你只要改这三类文件,我就能按规则做事:
external/Mycontent-book/book/**/*.md:正文内容external/Mycontent-book/1、soul 全部.txt:素材源(不要随便改结构)external/1、开发模板/**:需求、架构、部署的“标准答案”
2. 章节怎么放(目录就是结构)
- “篇”是一级目录
- “章”是二级目录
- “小节”是
.md文件
原则:尽量新增,不要频繁移动旧文件。
3. 写作动作建议(减少冲突、减少噪音)
- 一次改一篇/一章,写完再切下一个
- 同一小节尽量集中修改,不要碎片化改一堆次
4. 事实与数据怎么处理
- 数值、时间、对话:以素材文件里的原文为准
- 不确定就不写死,先把“素材引用段落”留在文档里
5. 自动同步的最佳姿势
- 开始写作前启动:
./scripts/autosync.sh - 写作时正常保存即可
- 停止同步:
Ctrl+C
6. 你想改规则怎么改
你直接改开发模板里的对应文档:
- 要改目标/范围:改
1、需求/业务需求.md - 要改结构/同步策略:改
2、架构/系统架构.md或8、部署/自动同步与分支策略.md - 要改跑站点方式:改
8、部署/本地运行.md
我会按你最新文档执行。