哥哥，不会写文档就 tm 别写，老老实实写代码行吗？
原文中文，约2500字，阅读约需6分钟。
📝
内容提要
文章讲述了作者在与某厂商对接时遇到的文档问题，包括文档内容不详、实例代码缺失和加密算法错误，导致现场测试失败。经过多次沟通，发现厂商提供的加密代码实际上是解密代码，浪费了时间。作者对文档质量表示不满，呼吁文档编写者应负责任。
🔎
延伸解读
文档错误的具体表现
文章指出厂商文档存在多个问题：内容不详、实例代码缺失、加密算法错误。其中加密算法错误最为严重，提供的代码实际是解密代码，而非加密代码，导致作者无法生成正确的控制二维码。这些错误直接影响了现场测试和项目上线进度。
问题排查的曲折过程
作者在测试失败后，通过对比项目经理提供的可用二维码，发现厂商提供的加密代码实为解密代码。经过多次尝试和计算，最终理清逻辑：加密需先对第25个数值异或，再处理其他数据。这一过程耗费了四五个小时，凸显了文档错误带来的时间成本。
对文档编写的启示
该事件提醒文档编写者应确保内容的准确性和完整性，特别是算法和代码示例。错误的文档不仅浪费对接方的时间，还可能影响项目进度。编写者需对文档负责，避免因疏忽导致他人重复排查。
❓
Q&A
文档质量差会导致什么问题？
文档内容不详和实例代码缺失会导致现场测试失败，影响项目进度。
厂商提供的加密算法有什么问题？
厂商提供的加密算法实际上是解密代码，导致测试无法进行。
作者对文档编写者有什么看法？
作者对文档质量表示不满，呼吁文档编写者应负责任。
现场测试失败的原因是什么？
现场测试失败的原因包括缺少密钥和错误的加密算法。
如何解决文档中的错误？
通过对比能用的二维码，理清加密和解密的逻辑，找到问题所在。
作者在测试过程中遇到了哪些困难？
作者在测试过程中遇到的困难包括设备不识别和文档内容不清晰。
🏷️
