是否有编写良好的 TeX 包文档的指南?

是否有编写良好的 TeX 包文档的指南?

我整理了一个基本包,我认为它很有用,而且运行良好。代码很简单,我想提交给 CTAN。

但是,首先,我必须编写文档,而我之前从未为任何东西编写过文档。有没有最佳实践指南,说明在概述功能和源代码时什么是有用的,什么是无用的?我看到 TeX 包文档种类繁多,不确定 PDF 包中需要什么级别的详细信息。

(需要说明的是,我问的是编写文档的指南内容而不是技术方面,这里已经很好地解决了为 CTAN 准备包时,什么是良好的做法?

相关内容