文件名称:docs-tutorial::writing_hand: 开发者如何编写优雅的技术文档
文件大小:3.62MB
文件格式:ZIP
更新时间:2024-05-22 21:16:12
draw.io 截图软件 snipate 4. 版本控制 SourceTree 5. 排版规范 中英文标点 专用名词拼写 英文左右空格 使用代码块和代码高亮 二、文档行文 1. 句子长度 2. 图文并茂 3. 起承转合 4. 引用链接 附录:主流文档协作平台 参考引用 开发者如何编写优雅的技术文档 前言 作为一名程序员,日常大部分的时间主要在埋头编码、调试。但在技术的世界里,不止有代码,如果仅仅只会编写程序是不够的。当你需要展示你的想法、技术分享、架构设计,这时候好的技术文档变的至关重要。 文档伴随开发者的日常工作,例如:开源软件官方文档、第三方平台文档、系统设计文档等等,好的技术文档让人赏心悦目、赞不绝口,但其中也不乏文档让人抓狂。仔细观察会发现,多数优秀的项目不光有着优雅的代码,文档也非常棒。 在项目开发进行时,常常会突破一些技术难点、技术无人区,这时候一篇经验总结类的技术博客可以帮你
【文件预览】:
docs-tutorial-main
----README.md(16KB)
----assets()
--------image-20210314003049439.png(390KB)
--------image-20210314002330558.png(685KB)
--------image-20210314002358591.png(633KB)
--------image-20210314003028491.png(1.05MB)
--------image-20210314003521112.png(386KB)
--------image-20210314002508169.png(81KB)
--------image-20210314012827724.png(765KB)