- 综合排序
- 最热优先
- 最新优先
- 来自专栏机械之心
技术文档规范
# 技术文档规范 文档采用 Markdown 语法书写。 强调 一些特殊的强调内容可以按照如下方式书写： 『注意』 『提示』 『参考』 # 4. 数值 # 4.1. 半角数字 数字一律使用半角形式，不得使用全角形式。 对于 4 ～ 6 位的数值，千分号是选用的，比如 1000 和 1,000 都可以接受。对于 7 位及以上的数值，千分号是必须的。 目录结构 技术手册目录结构是一部完整的书，建议采用下面的结构。 文件名 文档的文件名不得含有空格。 文件名必须使用半角字符，不得使用全角字符。这也意味着，中文不能用于文件名。
1.6K40编辑于 2023-04-07 - 来自专栏后端码事
Kafka 技术文档
Kafka 技术文档 Kafka创建背景 Kafka是一个消息系统，原本开发自LinkedIn，用作LinkedIn的活动流（Activity Stream）和运营数据处理管道（Pipeline）的基础 每个日志文件都是“log entries”序列，每一个log entry包含一个4字节整型数，其后跟N个字节的消息体。 磁盘上存储的消息格式如下： message length ：4 bytes “magic” value ： 1 byte crc ： 4 bytes payload ： n bytes 这个“log localhost:2181 --from-beginning --topic my-replicated-topic --my test message 1 --my test message 2 各项技术 大多数消息系统声称可以做到“精确的一次”，但是仔细阅读它们的的文档可以看到里面存在误导，比如没有说明当consumer或producer失败时怎么样，或者当有多个consumer并行时怎么样，或写入硬盘的数据丢失时又会怎么样
98110发布于 2020-09-11 - 来自专栏后端码事
RabbitMq 技术文档
abbitMq 技术文档 AMQP简介 AMQP即Advanced Message Queuing Protocol，高级消息队列协议，是面向消息中间件设计的应用层协议的一个开放标准。 RabbitMQ简介... 4 3.1 概念说明... 4 3.2 消息队列的使用过程... 5 3.3 RabbitMQ的特性... 5 4. c87c-4e5e-81ba-49433890b9ce' [x] Sent 'error_log :d01877d6-87c7-4e0a-a109-697d122bc4c9' [x] Sent c87c-4e5e-81ba-49433890b9ce' [x] Received 'error_log :d01877d6-87c7-4e0a-a109-697d122bc4c9' [x] Received c87c-4e5e-81ba-49433890b9ce' [x] Received 'error_log :d01877d6-87c7-4e0a-a109-697d122bc4c9' [x] Received
3K11发布于 2020-09-11 - 来自专栏杨建荣的学习笔记
关于技术文档
关于写技术文档，我觉得是很多做技术的同学头疼的，因为写起来确实有很多注意的细节，很花时间和精力，而反过来说，做技术的同学更头疼的是，工作中竟然没有文档说明，没有了文档那么就是个人主义了，所以文档的事情对很多人来说是一种比较纠结的情况 操作型文档，里面会有很多的技术细节 流程型文档，这种文档的主要是做一些铺垫和补充，比如有些内容简介，制度规约之类的。 而工作中，你的工作成果和技术积累，其实就是通过文档的积累整理出来的。我举三个例子。 首先第一个是文档库的事情。 文档库是很多公司都在使用的技术手段，如果我们要重新设计一个文档库，就会把他规划的很细很全，但是实际去写文档的时候，会发现事情比预想的要难一些，因为从业务和技术两个维度，技术上都可以实现，但是具体去操作的时候就有很大的差别 所以我们准备对已有的技术分享做一层沉淀，通过一些内容上的调整和梳理行程一个较为系统的文档，如果新员工来了之后，就会少走一些弯路。这个时候这个文档的重要性就体现出来了。 第三个是工作成果文档的事情。
921101发布于 2018-04-17 - 来自专栏icecream小屋
gensim技术文档
（2）利用初始化的模型将语料转化为对象的向量 1）TFIDF（词频逆文档频率） 2）LSI（潜在语义索引） 将词袋模型或TFIDF空间映射到低维度的潜在空间，推荐200-500为金标准，在达观数据的长文本分类中 LSI可以进行增量训练，只要有新文档可以一直输入模型当中，通过add_document方法。如果python报memoryerror，那就是内存不够了，需要降低维度。 3)LDA（隐含狄利克雷分配） LDA是LSA的概率扩展，也是向低纬度转化的方式 4)RP(随即映射) 目的在于减小空维度，通过随机性，近似的到文档之间的TFIDF距离，但对于大数据量很慢 4.相似度匹配 在得到文章对应的主题向量以后，就可以进行相似性匹配，将多个文档遍历进行匹配，然后排序选择相似度最大的文章，取其在训练集中对应的分类编号，作为测试文档的类别。
1.1K20发布于 2019-12-26 - 来自专栏云深之无迹
keli4使用文档
而且网上的文档良莠不齐，自带的才是最好的 ? 我们先找到这个文件的地址，然后反编译成HTML C:\Keil\C51\Hlp ? 在这里就有很多的文档 ? /uv4.chm ? 就编译完成了，然后用chrome浏览器打开记忆可以了 ? 这个是内部文档的软件周期开发图 C/C++ 编译器和宏汇编器 源文件由 µVision IDE 创建并传递给 C 或 C++ 编译器或宏汇编器。编译器和汇编器处理源文件并创建可重定位的目标文件。
1.1K20发布于 2021-06-25 - 来自专栏晓晨的专栏
IdentityServer4 实战文档
一.前言 IdentityServer4实战这个系列主要介绍一些在IdentityServer4（后文称：ids4），在实际使用过程中容易出现的问题，以及使用技巧，不定期更新，谢谢大家关注。 这些问题、技巧都是博主在将IdentityServer4用于实际生产环境的经验总结。
87320发布于 2018-06-22 - 来自专栏史上最简单的Spring Cloud教程
docker官方文档翻译4
article/details/80186178 本文出自方志朋的博客 个人博客纯净版：https://www.fangzhipeng.com/docker/2018/09/11/docker-trans4. 在第4部分中，将此应用程序部署到群集上，并在多台机器上运行它。 通过将多台机器连接到称为swarm的“Dockerized”群集，使多容器，多机器应用成为可能。 vbb1qbkb0o2z getstartedlab_web.3 john/get-started:part2 myvm2 Running ghii74p9budx getstartedlab_web.4 总结 在第4部分中，你了解了群体是什么，群体中的节点如何成为manager或workwer，创建群体并在其上部署应用程序。
97630编辑于 2022-05-07 【技术文档：技术传播的灯塔】
在技术的浩瀚海洋中，一份优秀的技术文档宛如精准的航海图，指引着航行者穿越波涛汹涌的未知领域。它是知识传承的载体，是团队协作的桥梁，更是产品成功的幕后英雄。然而，打造这样一份出色的技术文档并非易事。 一、技术文档的重要性技术文档是产品开发和维护过程中不可或缺的一部分。它不仅为开发者提供了详细的技术参考，也为新成员的快速上手提供了便利。一个清晰、准确的技术文档可以减少误解和错误，提高团队的工作效率。 适时更新：技术是不断发展的，技术文档也需要定期更新，以反映最新的技术变化和产品更新。 四、创新方法在技术文档的编写过程中，也可以采用一些创新的方法来提高文档的质量和可读性：交互式文档：利用现代技术，如 HTML5 和 JavaScript，创建交互式的技术文档，提供动态的示例和模拟。 社区参与：鼓励用户和开发者参与文档的编写和改进，通过社区的力量来丰富和完善文档内容。图片五、结语技术文档是技术传播的灯塔，它不仅照亮了技术实施的道路，也连接了知识的传承和团队的协作。
37800编辑于 2024-11-28- 来自专栏GopherCoder
技术文档如何编写？
关于文档编写的几个思维 近期重新组织了好几篇技术文档，把其中的一些感悟提炼出来。 按照现有文档完成后的文档输出如何组织？ 0. 程序员如何看待文档？ 程序员一定会是接触各种各样的技术文档，文档写的好与不好，大致都能区分出来。 但是对于自己写的文档却可以容忍 “丑陋” 、“难以理解”等...... 对技术、代码可以修改、修改、再修改，优化、优化、再优化...... 比如个人最崇拜的世界 Python 技术排名第五的作者： kennethreitz，他的开源作品：requests 再比如：开源 web 框架 Django 这两个项目的文档堪称是教科书式文档示例。 pic_2.png 这里有一篇中文技术文档写作规范参考：阮一峰：中文技术文档写作规范 标题： 我只谈论一点：标题原则上存在六级，即一级、二级、三级、四级、五级和六级标题。
8.1K61发布于 2018-06-06 - 来自专栏北京马哥教育
如何阅读技术文档
答：“去看文档” “Django的文档都是英文，我看不下去，怎么办” 答：“bla bla bla…. 关于英文的重要性” “Django的文档那么多，我是不是都得看完才行？” 后来随着对Django使用的越来越多，发现翻译的东西虽然能让你快速了解Django的一些东西，但是很多细节的地方还是需要去看英文文档才能明白，究其原因主要有两个：一是文档更新慢，二是文档是有志愿者参与翻译的 再之后，每每遇到问题请教同事或者在网上查得时候总能得到这样的反馈——你看过这部分的文档吗？！先去看看文档再来讨论。 于是乎，在这样不断的被鄙视过程中不断的熟悉了Django的官方文档，对于Django的问题也终于有了正确的认识——那就是，有问题就去看文档;出错了，一定是你文档看的不仔细。 除了在这样被鄙视的的状态下去看文档的，自己也尝试过去挨篇读文档，唯一的收获就是大概知道有哪些东西了，附带的收获就是对文档这东西不那么陌生了。
2.4K90发布于 2018-05-03 - 来自专栏AI SPPECH
4：Youtu-Parsing 文档解析模型：2B参数的文档智能解析技术深度解析
背景动机与当前热点 1.1 核心价值 在文档智能处理领域，传统的OCR和文档解析技术长期面临着处理复杂版面、结构化信息提取困难、推理速度慢等挑战。 未来趋势与前瞻预测 6.1 技术发展趋势 基于Youtu-Parsing的技术创新，未来文档解析技术可能朝着以下方向发展： 更高效的视觉编码：进一步优化视觉编码效率，减少计算开销 更强的结构化理解：提升对复杂文档结构的理解能力 行业生态影响 Youtu-Parsing的成功将对行业生态产生以下影响： 技术标准化：推动文档解析技术的标准化 开源协作：促进文档智能处理领域的开源协作 创业机会：催生基于文档解析技术的新创业方向 跨领域融合 ：促进AI技术与传统文档处理行业的融合 6.4 开放问题与研究方向 未来研究需要关注的开放问题包括： 如何进一步提升复杂文档的解析准确率？ 参考链接： 主要来源：Youtu-Parsing官方页 - Youtu-Parsing模型详情 主要来源：腾讯优图实验室官网 - 实验室技术介绍 辅助：文档解析技术研究综述 - 技术综述 辅助：视觉语言模型在文档理解中的应用
26410编辑于 2026-02-04 - 来自专栏混说Linux
搞技术，如何写好技术文档？
很多技术人自己非常轻视技术文档的书写，然而又时常抱怨文档不完善、质量差、更新不及时… 01 文档的重要性 高质量的文档对于一个组织或团队来说有非常多的益处，比如让代码和API更容易理解、错误更少； 关于文档的重要性，每个技术人或多或少都知道一些，但很多人还是没有写文档的习惯，为什么？ 1.像管理代码一样管理文档 对于如何写出好代码，整个技术圈已经有好多经验的总结了，比如书籍《重构》《代码简洁之道》…… 针对各种编程语言，也有相关的规范，比如国外的Google C++规范，国内的阿里Java 落地页的技术难度不高，但要求内容的有效性、完整性和分类清晰。 4.文档Review 在一个组织内，光靠个人去维护文档是不行的，必须得借助群体的智慧。 技术文档也算是文章的一种，所以一般也都会有这三部分，每个部分有其自己的作用，比如第一部分阐述问题，中间部分介绍具体的解决方案，第三部分总结要点。
77030编辑于 2022-11-18 - 来自专栏SpringBoot教程
documents4j 文档转换
documents4j 是一个 Java 库，可以将文档转换为另一种文档格式。 https://github.com/documents4j/documents4j<parent> <artifactId>spring-boot-starter-parent</artifactId >spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>com.documents4j </groupId> <artifactId>documents4j-local</artifactId> <version>1.1.5</version> </dependency > <dependency> <groupId>com.documents4j</groupId> <artifactId>documents4j-transformer-msoffice-word
1.2K00编辑于 2023-08-27 - 来自专栏庄闪闪的R语言手册
R文档沟通｜Dashboards入门（4）
简介 Dashboards入门前三期可见：R文档沟通｜Dashboards入门（1）；R文档沟通｜Dashboards入门（2）；R文档沟通｜Dashboards入门（3），今天给出该系列最后一期：在 在 flexdashboard 中使用 Shiny 可以将一个静态的 R Markdown 报告变成一个交互式文档。 需要注意的是，交互式文档需要部署到 Shiny 的服务器上，以便广泛共享(而静态 R Markdown 文档是可以附加到电子邮件或从任何标准 web 服务器提供的独立 web 页面)。 入门指南 在仪表盘中添加 Shiny 组件的步骤如下： 在文档顶部 YAML 元数据中添加 runtime: shiny。 注：文档顶部标记为 global 的 R 代码块在全局环境中都可以被调用。这将为用户带来更好的启动性能，强烈推荐大家使用。
3.2K30发布于 2021-06-25 - 来自专栏IT云清
4.Elasticsearch索引文档
但是在es中，我们可以把所有关于user的信息全部存在一个文档中，以user文档的形式存储，一个文档代表一个user。 索引（动词）： 索引一个文档 就是存储一个文档到一个 索引 （名词）中以便它可以被检索和查询到。这非常类似于 SQL 语句中的 INSERT 关键词，除了文档已存在时新文档会替换旧文档情况之外。 索引内 - 4.people索引保存在es集群中 上面这四步，我们用一条命令即可完成 PUT people/user/1 { "id":1, "name":"张三", "age":18, "杭州", "interests": [ "bastkeyball", "football" ], "create_time":"2018-02-04" } PUT people/user/4 { "id":4, "name":"张飞", "age":27, "address":"宁波", "interests": [ "bastkeyball", "football" ]
76320发布于 2019-01-22 - 来自专栏pandacode_cn
技术文档应该如何编写
# 衡量技术文档好坏的标准是什么 Martin(Bob大叔)曾在《代码整洁之道》一书打趣地说：当你的代码在做 Code Review 时，审查者要是愤怒地吼道： “What the fuck is this 根据所编写的文档，判断主要面向的受众是产品、技术、测试还是商务人员，尽量使用他们所能理解和熟悉的词汇和表达方式来表达。 提供必要的信息。 根据需要编写的技术类型，提供必要的信息，就像摄影拍照一样，有一些约定的摄影构图，例如：均衡式构图、对称式构图、对角线构图、三角形构图、九宫格构图等。 很多技术人员觉得编写文档比写代码还要难，还要头疼。其实写文档和写代码是类似的，很难一开始就写出完美的文档。应该是像写代码一样，一开始写得很丑陋，但没关系，至少有内容了。 # 参考资料 如何写好技术文档? (opens new window) 程序员如何编写高大上且实用的技术文档 (opens new window)
91820编辑于 2021-12-17 - 来自专栏DT乱“码”
Java agent技术原理文档
Java agent技术原理文档 Java代理 (agent) 是在你的main方法前的一个拦截器 (interceptor)，也就是在main方法执行之前，先执行agent代码。
1.5K80发布于 2018-02-09 - 来自专栏hotqin888的专栏
ONLYOFFICE文档转换开发技术
onlyoffice具有文档转换的功能，就是你给一个文档的地址，以及一些参数，post给document server，它会转换成你要的，然后返回一个文件地址，你收到这个地址，把文件下载下来保存，提供用户下载 测试代码如下： //文档格式转换 type Conversionsend struct { Async bool `json:"async"` Filetype string `json Example Document Title.docx" conversionsend.Url = "http://192.168.99.1/attachment/onlyoffice/111历史版本试验v4.
2.6K20发布于 2019-08-14 - 来自专栏LINUX阅码场
如何写好技术文档？
在整个职业生涯中，每个软件工程师都抱怨过文档的质量、数量或者完全缺乏文档。 01 为什么需要写文档？ 高质量文档对工程组织有巨大的好处。代码和api变得更容易理解。 软件工程师经常需要编写几种主要类型的文档： 参考文档，包括注释 设计文档； 教程； 概念性文档； 1.参考文档 参考文档是工程师最常编写的文档类型;事实上，他们经常需要每天写一些参考文档。 4.概念性文档 有些代码需要更深入的解释或见解，而不是仅仅通过阅读参考文档就能得到的。在这些情况下，我们需要概念性文档来提供api或系统的概述。 技术文档得益于三种不同类型的review，每种审查都强调不同的方面： 专业的视角来保证准确性：一般由团队里比较资深的人负责，他们关注的核心点是文档写的对不对，专不专业。 06 文档写作的哲学 下面的部分更多地是关于技术写作最佳实践的论述。
3.5K20发布于 2021-09-18
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号