代码文档化 #
TLDR：良好管理的文档化可以提高软件工程的效率并确保代码质量。Obsidian (opens new window)是一款帮助组织文本文件集合作为结构化知识库的应用程序，是所有软件工程师的理想工具。
代码文档化 #
术语“代码文档化”指的是类似代码注释、README 文件和从代码生成的文档。我将重点关注这个领域，因为对于与代码相关的工程师来说，它具有很高的价值。
README 文件 #
对于已经在开发中的项目来说，最有价值的代码文档类型无疑是README 文件 (opens new window)，一个创意的文档。 写README文件的指南可以使审阅者完全了解你的项目的所有内容，包括谁、什么、何时以及如何，从而使你的项目与其他项目脱颖而出。
这是其他工程师们在遇到你的项目时首先看到的文件，对于他们来说，它提供了关于代码目的、使用说明以及构建方法的信息。
编写README文件 #
作为一名工程师，了解如何通过编写README文件来记录你的项目是非常重要的。你首先需要学会创建和编辑README文件，之后可以专注于提高其内容、结构和正确性。该文件通常具有.md扩展名，表示它是一个MarkDown (opens new window)文件。
MarkDown，又一种标记语言 #
MarkDown是一种轻量级标记语言，允许你在纯文本文档中添加格式化元素，从而轻松创建格式化的文档。 Markdown编辑器和IDE支持
虽然您可以使用任何文本编辑器来编写Markdown，但是Markdown编辑器 (opens new window)提供了语法高亮、实时预览、键盘快捷键和高级格式等功能，帮助作家和内容创作者使用基本的标记语言（如井号）来格式化他们的作品。
大多数IDE，如Visual Studio和JetBrains系列，以及像Visual Studio Code这样的高级代码编辑器，都有内置的功能或扩展，提供了质量上乘的Markdown编辑体验，包括预览窗口和所见即所得的编辑器窗口。这意味着您不需要同时使用两种不同的工具来处理代码和文档。虽然您真正需要这样做的频率有多高呢？
Obsidia 使用专门的工具来组织和编辑Markdown文件相比独立编辑器和面向代码的集成开发环境具有许多优势。大约一年前，我发现了一个叫做Obsidian (opens new window)的应用程序，我对它简直喜欢得无法自拔。它主要被称为一款笔记应用，但它的质量非常高，通常被称为“第二大脑”、“个人知识管理系统（PKMS）”和“Markdown的VS Code”。
以下是一些突出Obsidian关键功能的文章。我不必重复它们所说的内容：