原来我也会写文档

墨衍会员 · AI 创作全网分发 墨衍智能分发 本文由作者通过墨衍一键同步至各平台 1分发平台 900+累计阅读 973平均单平台已同步平台优快云微信公众号微博知乎掘金百家号博客园抖音小红书 你的文章也可以这样分发 墨衍会员 ¥399起/年，写一次发全网我也要 → 码龄24年

关注

原创最新推荐文章于 2026-03-17 01:27:04 发布 973 阅读 AI 写同款· GEO 优化 ›

基于PDF文档结构的数字隐写 PDF隐写阅读详情

一直都很反感写文档，觉得比起文档我更愿意花时间写代码，虽然都是费时费力的活儿，但我还是比较喜欢写代码，呵呵。
这两天静下心来闷头为自己写的一个小框架写说明，或者说是使用指南。从头开始就一个人坐那里边写边抱怨，可是抱怨好了继续写……大框架搭好后就开始像填充一样的写一个个小章节，也许是文档看多了，写着写着觉得写文档其实和写作文还是不一样的，毕竟不是写散文小说……虽说如此，可我还是不太乐意写文档，估计程序员都差不多吧。
等到初稿完成时，看看页数，算上封面8页，当中嵌了些范例的代码，大大小小几级标题，还是蛮漂亮的，回头想想，写文档嘛也就这点事

收录于

项目相关

当前文章被收录于：

项目相关

28 篇文章 0 人学习

订阅专栏查看详情

当前文章被以下社区和专栏收录：

标签

#文档 #框架

写技术文档之算法篇写技术文档方法：算法题： 1，图示，并配上文字花费时间太多了，我有很多时间的时候考虑，这里面也有一些技巧，值得学习这里推荐画图工具draw.io 和process 思维导图工具幕布 2，语言解释 2.1 你要把算法解释很透彻，要么把流程更改写一遍 2.2.最重要的是有一句话深刻透彻，直接解释所有，有时候一点及一切，记得加粗 2.3加一些专业术语，可以显得你的专业性，最好是你可以对它进行解释，或者引入另一篇文章，推荐好的文章，这里加专业术语不可让文章越来越深奥，而是蜻蜓点水，给读者说明体系内的叫法，但阅读详情

相关推荐

如何写软件设计文档？

对于文档的总结，本该在软工之后，文档书写完后进行的。可之前，对于文档的书写没有多少感觉。师傅检查了一遍我的文档，并对文档存在的问题及我的情况进行了分析，让我重新改一改。这一遍，让我对文档有了很多新的认识。为什么要写文档？这可能是很多人都想要问的一个问题。为什么要写文档呢？前前后后，那么琐碎，那么麻烦，要是想研究个什么方案，大家开个会，当面研究、解

不忘初心 1万+

文档隐写溯源技术分析

本文是信息安全综合设计的课程报告。全文：4000字+ 1 文档隐写溯源技术的意义在如今的信息时代，信息技术的迅速发展使原本以纸张形式保存的大量重要文档转变为以电子文档形式保存。得益于电子文档的创建快速、易于存储、方便管理、传播共享等优点，许多企业、政府单位的日常文件甚至机密信息都是利用电子文档的形式进行存储与传输。这些文档中包含了多种多样的信息，具有巨大的经济价值和应用价值。但是，许多涉密文档的使用，并没有得到有效的监督和管理，信息泄露事件频有发生。2021年5月9日，宁夏银川一份名为《关于境外输.

拾年之璐 4632

如何写好技术文档——来自Google十多年的文档经验

本文大部分内容翻译总结自《Software Engineering at Google》第10章节 Documentation。首先声明，本问所说的文档不仅限于纯文本文档，还包含代码注释(注释也是一种特殊形式的文档)。高质量的文档对于一个组织或团队来说有非常多的益处，比如让代码和API更容易理解、错误更少；让团队成员更专注于目标；也可以让一些手工操作更容易；另外如果有新成员加入的话有文档也会让他们更快融入……写文档有比较严重的收益滞后性，不像测试，你跑一个测试case，它能立即告诉你是对还是错，它的

Moonxiyue的博客 378

java开发文档怎么写_程序员该不该写技术文档，怎么写文档，易懂又能提升自己...

最近公司项目的调用量突然涨了一大波，很多系统都纷纷扛不住了，于是需要对系统进行优化，系统优化的第一步，便是梳理业务！在这个过程中，经常出现了这样一些情况，发现数据库的某些字段，没有注释，也没有一定的文档来诠释它做什么作用。而这个项目又是多达20，30人一起开发维护的，没有人能够从头到尾说得清这个项目的主要流程。写文档，似乎在国内的程序员，最不屑的一件事情了。作为一个程序员，有没有必要写技术文档呢？...

weixin_39914975的博客 3067

Python实战：3种高效方法将txt转csv（附pandas对比测试）

本文针对Python中将txt文件转换为csv格式的需求，深度评测了open()、csv模块和pandas三种主流方法。通过详尽的性能对比测试，从执行效率、内存占用和适用场景等维度提供选型指南，帮助开发者根据数据规模与复杂度选择最高效的转换方案。

weixin_29073241的博客 261

Fastp实战指南：高效处理fastq数据的质控技巧

本文是Fastp实战指南，详细介绍了如何使用Fastp工具高效处理fastq数据的质控技巧。从数据清洗的必要性、基础命令解析，到高级参数定制、UMI数据处理及批量自动化流程，提供一站式解决方案。Fastp以其“All-in-One”的快速质控能力，帮助用户确保测序数据质量，为后续生物信息学分析奠定可靠基础。

weixin_29254029的博客 389

文档要怎么写？

题记：今天立秋了，明天永远是美好的一天场景最近给运维人员写了一份部署三个项目的文档，由于系统需要和其他两个系统交互，所以在配置方面复杂了些，尤其是对xml文件地址配置这块，经常出问题。当基本功能实现的时候，给运维人员去部署的时候，写文档不单单是给别人写，更多的是给自己写。写的过程中思路清晰了，一切都会变得明朗起来，有一种山穷水复疑无路，柳暗花明又一村的感觉，并且一下子把需要大脑中记忆的这些事情全部转移到了文字上，一个字，舒服~，就像清理了电脑中的垃圾空间一样。不过当我把写好的文档实

Xinghf 6763

利用Nginx反向代理实现GitLab自定义域名的高效配置

本文详细介绍了如何利用Nginx反向代理实现GitLab自定义域名的高效配置。通过统一域名管理、性能优化和安全加固，提升GitLab的访问效率和安全性。文章包含前期准备、GitLab基础配置、Nginx反向代理设置及常见问题排查，帮助开发者快速完成部署。

weixin_28834169的博客 164

四、文档隐写

解释：一般文档隐写多存在于word当中，下面就介绍一下可能的隐写。

黑日里不灭的light 2867

教你读懂techpoint视频解码芯片tp2855规格书（第一部分）

所有的控制环都是可编程的，以实现最大化的灵活性。对于NTSC/PAL输入，输出时钟和采样结构是非标准的，以便在多路复用输出时与HD格式一同工作。所有通道的音频数据都可以选择性地级联，以实现最大的灵活性。TP2855是一款通用的高清/标清视频解码器芯片，其支持对HD-TVI、NTSC/PAL制式960H分辨率及普通AHD视频格式的解码。TP2855具有内部钳位，在每个通道上都有自动增益控制放大器，用于最佳的信号调节。即使在使用低质量和长线缆的条件下，它的可编程均衡放大器和自动控制环也能维持尚佳的表现。

hufan92的博客 4918

【测开求职】面试题：JAVA 吐血整理

本篇文章包含本次测开工程师秋招过程中遇到的所有JAVA面试题，全文两万字，亲测应对各个大厂的面试毫无压力👉

vector的博客 1211

你写文档吗?你为什么应该写文档?

http://www.cnblogs.com/mindsbook/archive/2009/12/06/do_you_write_doc.html?from=groupmessage 你写文档吗?你为什么应该写文档? 本博客所有内容采用 Creative Commons Licenses 许可使用. 引用本内容时，请保留朱涛, 出处，并且非商业 . 点击订阅来订阅本博客.(推...

zhong12270107的博客 374

《QT+PCL》点云的点选与框选

【代码】《QT+PCL》点云的点选与框选。

阁楼 3602

怎么写好程序文档

转载自http://blog.youkuaiyun.com/laoyang360/article/details/51712757

eon_sos的博客 3075

MICCAI‘23 | TSegFormer：基于几何引导Transformer的口内扫描3D牙齿分割

光学口内扫描仪（IOS）在数字牙科中广泛应用于提供牙冠和牙龈的详细3D信息。准确的3D牙齿分割对于各种牙科应用至关重要，但现有方法在复杂边界处容易出错，并且在不同患者之间表现不佳。本文提出了TSegFormer，它通过多任务3D Transformer架构捕捉IOS点云中不同牙齿和牙龈之间的局部和全局依赖关系。此外，作者设计了一种基于新颖点曲率的几何引导损失，以端到端方式优化边界，避免了耗时的后处理，从而实现临床适用的分割。

小白学视觉 291

【Qwen2微调实战】LLaMA-Factory框架对Qwen2-7B模型的微调实践

在人工智能的浪潮中，大型语言模型（LLMs）正逐渐成为研究和应用的热点。它们在自然语言处理（NLP）的各个领域，如文本生成、翻译、问答等任务中展现出了卓越的能力。Qwen2-7B模型，作为该领域的佼佼者，不仅因其庞大的参数量和强大的表示能力受到关注，更因其在微调后能够更好地适应特定任务而备受关注。本文将详细介绍如何利用LLaMA-Factory这一高效的微调框架对Qwen2-7B进行微调，以期达到提升模型在特定任务上的表现。

寻道AI，探索AI无限可能！ 2万+

让自己爱上写文档，这很重要！

大家好，我是bug菌，渐渐发现年轻的工程师都不爱写文档，而老工程写的文档都非常漂亮，至于原因，我觉得大家可以细品~~~所以今天找来一篇好文章，大家参考一下~本文大部分内容翻译总结自《Sof...

326

老版QQ原生表情gif动态

这是老版的QQ表情，不过全是动态的的，Windows照片查看器是不会动的，可以右击用浏览器打开查看，再说一遍是老版的，只是分享给宁愿用老版也要动态的人。

如何写好一份文档

最后再做一个总结，文档不是一成不变的，在我接触的IT项目中包括有“需求文档，设计文档，测试报告，用户手册，部署方案，会议纪要，调研报告”等众多形式各异的文档，并且每种文档又有特定的子文档等。关于版本号的说明，一般来说版本号分为三位，第一位表示大版本（可以以年计算，也可以以项目阶段计算），第二位表示一个有新的完整功能的版本，第三位表示一个小迭代版本。：适当的介绍是必不可少的，如上图文档的引言着重介绍文档的作用和背景，系统概述介绍本文档所描述的系统，系统架构描述系统采用的总体架构，接下来才是正常的设计模块！

zbcoder的博客 1361

怀旧版电脑GBC模拟器

再现原版GBC掌机的界面，电脑运行连游戏界面都一样大小，很怀旧，很真实，（英文版）强烈推荐，很小的文件，很难才找到的。

efm32 入门.pdf

本PDF共计22页，介绍的是操作驱动API，下载与否自己斟酌。

如何写前端技术方案文档?

大厂技术高级前端Node进阶点击上方程序员成长指北，关注公众号回复1，加入高级Node交流群前言百度百科对计算机软件的的定义为：“计算机软件( Software，也称软件)是指计...

程序员成长指北 1万+

迈瑞BS系列全自动生化分析仪LIS协议接口手册(内含HL7和ASTM)

迈瑞BS系列全自动生化分析仪LIS协议接口手册，内含HL7和ASTM)

聊一聊 - 如何写好README文档

写好README实际上并没有说最标准的答案，最本质上的思路是把自己所负责的组件当作一个产品去看待，把使用组件的人当作用户去看待，通过文档甚至视频等方式，去向他们宣传我们的组件，让他们都能用我们的组件以及觉得这个组件好用

Dr_chaser的博客 1333

文档为什么这么难写哈

文档为什么这么难写哈这样的文档写的很烦哈你们平常写文档都是怎么写的呢

过客阵营 -- 简单的就要最简单 157

写技术文档也有“三板斧”：写清楚、写明白、能落地

在技术的海洋中，文档是人与人之间沟通的桥梁。它不仅是写给自己看的备忘录，更是写给后来者的说明书。优秀的文档不是锦上添花，而是核心竞争力的一部分。它是团队知识的载体，是产品落地的通道，更是让后人少踩坑的好帮手。希望每一位技术人都能写出“能被人读懂、能被人用上”的技术文档，为团队协作和技术传播添砖加瓦！一份优秀的技术文档就像一棵树：有主干、有分支、有层次。那么，一份真正优秀的技术文档，需要做到什么？再炫酷的方案，如果读者照着做都跑不起来，那这份文档就是失败的。比如：新手、开发人员、运维工程师，还是产品经理？