为什么我放弃了我的 30 年开源项目

主要观点:作者 1996 年开始的开源项目 Program Enhanced Document(PET),旨在创建新的文档维护方法,历经多个版本和语言实现,如 Perl 版本的 Jamal、Python 版本的 Pyama 以及 Java 版本的 Jamal 等。虽 PET 理念有效,但 Jamal 未被广泛使用,原因可能是过于复杂。随着 LLM 的出现,文档的重要性发生变化,更需精确参考文本,可利用 Jamal 片段功能维护。对于想享受 PET 优势又不想使用 Jamal 的,可使用 100 行 Python 代码实现类似功能。
关键信息

  • 1996 年开始的开源项目,历时 30 年,曾开发多个软件版本支持文档维护理念。
  • Perl 版本 Jamal 用于维护 ScriptBasic 文档和统一 Makefile,代码 2010 年更新,有 63 星。
  • Python 版本 Pyama 为解决 Jamal 在编辑文件时的不便而开发,7 年前更新,因出版社要求在 Microsoft Word 编辑而未用于第一本书。
  • Java 版本 Jamal 集成多种语言,可生成大量 XML 跟踪输出,7 年前更新。
  • Jamal 虽功能多但复杂,未被广泛使用,原因可能是门槛高。
  • LLM 出现后,文档重要性变化,需更精确参考文本,可利用 Jamal 片段功能。
  • 推荐使用 Python 实现类似 Jamal 功能的 100 行代码,可根据需求修改,不强制使用某一工具,倡导使用 PET 文档。
    重要细节
  • 如 PET 理念中,文档应自动维护,避免复制粘贴导致冗余和不一致,如 Maven 项目版本应引用而不是复制。
  • Pyama 作为离线“编辑器”,通过将编辑命令写入文件来编辑文件。
  • Java 版本 Jamal 拆分多个模块,实现多种功能,如处理代码特征、从多种文件格式获取文本等。
  • 作者创建 Turicum 语言并利用 LLM 辅助文档工作,如添加 BNF 等。
  • 推荐的 100 行 Python 代码用于在 Markdown 文档中分层编号章节等,可根据需求编写脚本。
阅读 43
0 条评论