新手入门文档开发的工具选择与作品集 | 技术传播

大家好，我是在上一篇文章与大一学生关于技术文档工程的交流 | 技术传播发出后，立刻收获了3个取关，顿感心里“咯噔”一下，生怕自己是不是哪里说得不对的睿齐。

不过，在子弹飞了一会儿之后，也有更多的同学和同行，借由这篇文章联系到我，与我交流他们的想法和问题。

很开心听到你们说，从这些豆腐块儿的小文章中找到共鸣，获得启发……每一个正面反馈，都是我持续写作和分享的最大动力；同时，你们提出的问题，也在不断启发我深化自己的思考。

今天这篇文章，同样得自于一位知乎网友的启发：

借此机会，让我们来聊一聊，新手入门技术文档开发时，应该如何选择文档开发工具进行学习和实践，以及如何准备个人作品集做好自我展示。

目前，文档开发工具选型并没有一定的规范：

用什么工具，取决于你将要进入的工作环境。入行前不必押注某一款，更不必为【没学过XXX】而感到焦虑——借助AI辅助学习文档开发工具的使用，简单易用到可以直接进行内容和源码编写。

真正拉开差距的，往往不是你会不会某个软件，而是你对技术的学习、思考、理解和表达；以及能否运用结构化写作，体现你在某一领域的知识和经验的积累。在如今AI快速发展的时代，尝试在【AI+文档】领域持续地学习实践，深入地探索和输出，或许是个不错的选择？

当然，如果你有明确目标，想要竞争某厂的实习或工作机会，也可以选择有针对性地学习实践相关工具。

对于一般场景的应用入门，我个人比较推荐Sphinx文档工程。这里面可能有一些私心的成分在——因为我自己正在使用Sphinx；但凭心而论，Sphinx绝对不失为【大神级】的文档开发工具：

可以看到，以上实践已经超出了单纯的【工具使用】和【文档开发】的范畴，更是对【工程理念】和【流程规范】的系统性思考。尝试把自己放在主管的位置上去实践和思考，或许可以为你的简历和面试增色不少。

比如，这是我在实践Sphinx文档工程的时候进行的系统设计，每一个环节都可以当做一个课题，进行深入的实践和积累；但也绝不仅限于此。

或许你可以考虑尝试以下2个方向中的一个。

方向一：为开源项目写/改文档。

选择一个你感兴趣的开源项目，积极参与开源项目贡献，尝试为它编写入门指南、API说明或故障排查——哪怕只是从最简单的修正文档错误开始；并参与社群交流，让更多人看到你的贡献，以及你对信息架构、面向读者的表达、与代码/版本协同的能力。

在这里，你将获得真实的项目经验；在同频开发者面前曝光的机会；以及，你的写作，毫无疑问地是在为开源项目输出价值。

方向二：技术博客，或者技术文档站。

选一个你熟悉的小领域，从零搭一个【产品文档】或【技术说明】站点，包含目录、多页、可发布。展示的是：结构化写作、版本管理、发布流程。

以【见睿思齐】为例，目前主要输出【Obsidian实践】【AI实践】，以及【技术传播】相关内容。这些内容，都是我在平台之外，证明【我是谁】的可靠背书。

不必追求大而全，一个完整、可访问、能讲出【我做了什么】【为什么这样写】的项目，比一堆半成品更有说服力。

工具为场景服务；能力才是长期筹码。从【开源文档】或者【自建小站】出发，深入某个技术领域；养成结构化的写作风格；进一步理解工程理念和流程规范，把【如何思考】【如何落地】讲清楚——这应该就是最好的学习和实践了吧。

相关推荐：