文件名称:technical_documentation_class
文件大小:229KB
文件格式:ZIP
更新时间:2024-04-21 14:36:10
技术文档 什么是什么,为谁而干? 技术文档是一组文本,代码,图表,图像和图解,它们描述了您所选择的技术问题的解决方案。 它具有以下目的: 向同事或继任者描述您的想法,以便他们参与或继续您的工作; 向更广泛的公众以及可能的未来雇主描述您的项目。 释放您的思想和复杂信息的记忆力; 组织您的想法,因为写下来的想法是实施的第一步; 重要的是在工作时(而不是在最后)连续编写文档。 考虑一下它是您项目的日记。 开始时并不一定要漂亮,您可以使用任何文本编辑器或笔和纸。 您编写的许多内容可能最终都不会最终版本,因此不要害怕写下所有最小的想法。 README.md文件 如果你看看任何积极开发库(这里有几个例子: , , ),你会发现他们都有一个在他们的根文件夹名为README.md文件。 该文件包含文档,在GitHub上,该文件自动显示在资源库页面的文件夹下面。 您可以在此存储库的文件中
【文件预览】:
technical_documentation_class-master
----README_template.md(2KB)
----.gitignore(10B)
----README.md(4KB)
----philly-magic-garden.jpg(225KB)