文档的管理方式

• 文档的管理方式
  • tool
  • iter
  • category and anchor
  • pics
  • table
  • refer

摘要 这里只对手写文档的管理进行个人方式的总结。包括文档的书写和存储等。

以下部分基于假设：你使用Markdown书写文档。

tool

Markdown， VScode， MPE¹， markdownlint， Git, GitHub ²

iter

理论上，应使用markdown语言进行编辑，并控制每行只有一句话。而在markdown语言中，若不隔行则并不会换行。这样更改文件后，git上更容易追溯。 发现新的版本好像不支持了。
需要我们快速迭代，并且在每一次的commit中写清楚本次修改的story。

category and anchor

为了规范和快速索引，每个文档都应当有目录和锚，方便定位。具体使用MPE的create toc功能。

另外，方便定位，推荐使用英文作为标题。

pics

talk is cheap, show me the pic.

使用markdown画图请参考：MPE文档及plantuml文档

其他工具使用如ProcessOn，draw.io,gliffy diagram等。

上传图片只需要使用本地图片，而需要记得使用IM删除图片的元信息。外部图床可以使用sm.ms。但从安全角度不建议。

table

简单表格可以直接完成。
复杂表格可以借助execl和http://pressbin.com/tools/excel_to_html_table/index.html实现。
总的来说支持的不是很好，推荐直接@import "file.csv"。

refer

合理使用引用字符和脚注来拓展文本的内容。

©广白

---

1. MPE中文文档 ↩︎

2. github已经免费开放私有仓库 ↩︎