在2023年,不应就软件项目中优秀文档的附加值展开争论。软件工程师应该能够访问适当的知识库,这取决于资源类型和他们需要的时间。软件开发人员的技术文档可以采取多种形式,包括常青文档(例如,建立项目的程序)、开发人员在项目中应遵循的体系结构原则、发布文档,编码标准和指南、入职指南等等。
技术受众的文档是一项艰巨的挑战,原因有很多:它需要一个严格的组织来保持最新。它很快就会被那些经常不喜欢花时间维护文档的工程师搁置一边。一个常见的错误是将所有类别的文档都放在同一级别:例如,安装软件的绿色程序与定期发展的编码标准不同。你不需要在同一时间和同一频率掌握这些知识。一旦您了解了这一点,就可以定义不同的流程和渠道来管理您的技术文档
在这篇文章中,我们概述了35种现有的技术知识管理工具,这些工具可以分为以下主要类别:
- 类似Wiki的工具,工程师在工具的UI中编写文档(例如:Notion、Confluence…)
- 活的知识工具,即知识从开发人员的工具中产生,然后变得动态的,例如用于代码分析和入职会议(例如:Promyze);
- 沟通工具,如问答平台(例如:团队的StackOverflow…)
- 生成的wiki工具,开发人员通常会在其中以标记方式编写文档,然后所有的魔法都会发生(例如:ReadTheDocs,…)
本文不考虑提供最终用户文档的工具,如自助服务门户(Zendesk、Intercom等)。我们专注于开发人员为开发人员制作的文档。我们还排除了API文档工具,这些工具属于值得发表文章的特定领域。
Acreom
记录笔记,分解问题,跟踪进度,创建知识库。
AnswerHub
通过在线社区和知识共享,使开发人员和团队能够学习、共享并取得成功。
AppFlowy
开源替代Noation
Archbee
Build better product documentation — faster
Bit.ai
Next-Gen Document Collaboration Platform for Teams!
BookStack
(Open Source) BookStack is a simple, self-hosted, easy-to-use platform for organizing and storing information.
ClickUp
Save time with the all-in-one productivity platform that brings teams, tasks, and tools together in one place.
Coda
The all-in-one doc for teams.
CodeStream
New Relic CodeStream is a free open-source extension for VS Code, Visual Studio, and JetBrains.
Confluence
Confluence is your remote-friendly team workspace where knowledge and collaboration meet.
Daux.io
(OpenSource) The Easiest Way To Document Your Project.
Developerhub.io
All-in-One Platform for Online Documentation.
Docusaurus
(OpenSource) Build optimized websites quickly, focus on your content.
Flarum
(Open Source) Forums made simple. Modern, fast, and free!
Forem
(Open Source) Forem is an open source platform for building modern, independent, and safe communities.
GitBook
Where software teams break knowledge silos. (We use it at Promyze for our public documentation)
GitHub Pages
Websites for you and your projects.
Hugo
(OpenSource) The world’s fastest framework for building websites.
Jekyll
Transform your plain text into static websites and blogs.
mdBook
Static site generator from Markdown files.
MkDocs
(Open Source) Project documentation with Markdown.
Notion
The all-in-one workspace — for your tasks, notes, wikis, and calendar.
Notaku
Build a full-featured Docs website in minutes, using Notion as CM
Nuclino
A modern, simple, and blazingly fast way to collaborate — bring knowledge, docs, and projects together in one place.
Papyrs
The easiest way to create an online for your company.
Read The Docs
(Open Source) Read the Docs simplifies software documentation by automating building, versioning, and hosting of your docs for you.
SkyDocs
(OpenSource) SkyDocs is a lightweight static documentation builder with MarkDown.
Slab
Build a culture of knowledge-sharing today.
Sphinx
(OpenSource) Sphinx makes it easy to create intelligent and beautiful documentation.
Stack Overflow For Teams
Knowledge sharing and collaboration without distractions.
Swimm
Documentation Platform Built for Engineers.
TechDocs
Spotify’s docs-like-code plugin for Backstage.
Tettra
The best way to organize and share knowledge with your teammates.
Wiki.js
(OpenSource) The most powerful and extensible open source Wiki software
Promyze
Connect Developers’ Knowledge and share best coding practices, fully integrated in developers tools.
仅此而已,各位;我们希望这篇文章能让您对软件开发人员的知识库工具的现状有一个概述。
在上面引用的那些例子中,在Promyze,我们使用Notion来收集材料,例如创建IDE扩展的新版本的过程。我们使用GitBook来发布我们平台的用户文档。最后,我们在内部使用Promyze工具不断提高新的编码标准。我们将这些标准直接引入IDE和代码评审中,因为我们认为现在是开发人员需要这些知识的时候。您不使用在选项卡中打开的Wiki进行编码。
- 登录 发表评论