关于写技术文档，我觉得是很多做技术的同学头疼的，因为写起来确实有很多注意的细节，很花时间和精力，而反过来说，做技术的同学更头疼的是，工作中竟然没有文档说明，没有了文档那么就是个人主义了，所以文档的事情对很多人来说是一种比较纠结的情况...操作型文档，里面会有很多的技术细节 流程型文档，这种文档的主要是做一些铺垫和补充，比如有些内容简介，制度规约之类的。...而工作中，你的工作成果和技术积累，其实就是通过文档的积累整理出来的。我举三个例子。 首先第一个是文档库的事情。...文档库是很多公司都在使用的技术手段，如果我们要重新设计一个文档库，就会把他规划的很细很全，但是实际去写文档的时候，会发现事情比预想的要难一些，因为从业务和技术两个维度，技术上都可以实现，但是具体去操作的时候就有很大的差别...所以我们准备对已有的技术分享做一层沉淀，通过一些内容上的调整和梳理行程一个较为系统的文档，如果新员工来了之后，就会少走一些弯路。这个时候这个文档的重要性就体现出来了。 第三个是工作成果文档的事情。
Java agent技术原理文档 Java代理 (agent) 是在你的main方法前的一个拦截器 (interceptor)，也就是在main方法执行之前，先执行agent代码。...主要利用就是Java SE 5 开始有的新特性，即利用 java.lang.instrument 做动态 Instrumentation 使开发者可以构建独立于应用程序的java agent(代理)程序
研发过程中，文档很重要，但更重要的可能是「惯性思维」 开发到底要不要写文档（注释），要写多少文档，要怎么写文档，想必在大家工作的各个阶段都会有不同的体会，不同人也会有不同的意见。...我是支持多写文档的，但是文档也有个弊端，就是不容易做到实时更新，代码即文档这个说法很酷，但是实际操作下来，并没有想象中这么容易的，都要耗费时间去维护的。...另外就是不同的同学写文档的风格不一样，有人喜欢用富文本，有人喜欢用 Markdown，有人喜欢用 tab 有人喜欢用空格，有人经常不注意换行的行数和格式，有人写文档写的很随意，觉得写了就万事大吉了，而大多数人都对自己的文档很有信心...因为文档更新不及时，或者一些其他原因，很多时候看其他人的文档，并不能让我从0到100，很多时候能到10就不错了。 所以这里我提一个说法，就是大家在重视文档的同时，不要忘记我们开发的「惯性」。...工作时，尽量用所谓的「惯性思维」或者「大众思维」去工作，不要在工作和工程上制造太多潜规则，越多的潜规则，就需要越多的文档去解释和说明，久而久之，这些就会变成技术债，船大难掉头，如果一开始就注意到这些问题
# 技术文档规范 文档采用 Markdown 语法书写。...反例：关于文件的输出，请参照第 1.3 节（见第 26 页。） 正例：关于文件的输出，请参照第 1.3 节（见第 26 页）。 # 5.3. 逗号 逗号 ， 表示句子内部的一般性停顿。...目录结构 技术手册目录结构是一部完整的书，建议采用下面的结构。...文件名 文档的文件名不得含有空格。 文件名必须使用半角字符，不得使用全角字符。这也意味着，中文不能用于文件名。...Emoji 在 markdown 文档中，普遍会使用 emoji，帮助理解内容。但是，如果滥用 emoji，可能会适得其反。
JNPF快速开发平台 JNPF快速开发平台采用前后端分离技术、采用B/S架构开发，形成一站式开发多端（APP+PC）使用。 使用JNPF开发平台可以简单、快速、高效的构建各种类型java项目。...JAVA版介绍 JNPF.java版采用前后端分离，可将代码直接导入idea运行，也可将前后端代码利用ngnix分开部署。...JNPF主体架构、技术 采用前后端分离技术，主体架构为B/S，PC端和APP混合开发。 前后端分离特点 JNPF快速开发平台平台采用全新的前后端分离架构模式。...主要技术栈 前端 JS框架：jquery, bootstrap, vue UI框架:bootstrap、ElementUI 富文本编辑：UEditor 文件上传：webuploader 客户端验证：jquery-validate...lodop、h5打印 APP JS框架:uniapp, h5, vue APP UI框架:uniapp 后端 核心框架: springboot 数据库框架：mybatisplus 缓存框架：redis 接口文档
2、作为自己的备忘录，减轻记忆的负担，也方便后续快速跟进； 3、先从宏观角度来思考完备性，实现过程中可以作为指引； 4、方便其他同学来提出建议，共建和谐社会； 5、和团队其他角色沟通用时，脑海关于需求的千丝万缕先用文字...； ==> 没有价值； 按照这个思路，我常写的文档以下几种： 1、方案设计文档——方案评审用； 2、经验总结文档——抽象避免重复采坑； 3、问题处理文档——专项问题跟进； 4、知识提炼文档——深入学习...1、明确此篇文档的目标人群； 以技术方案评审文档为例，文档的目标人群是参与评审的技术同学，所以描述需要更加抽象，避免出现大量的细节； 以反馈问题跟进文档为例，文档的目标人群是运营、产品、开发等，所以需要针对特定的逻辑...，用通俗的语言去描述问题的前因后果，避免出现代码逻辑和无法理解的词汇； 2、理清要表述问题的中心； 技术方案评审文档，是为了阐述技术方案的整体设计； 反馈问题跟进文档，是为了针对某个问题给出结论；...3、梳理整个描述逻辑； 以技术方案评审文档为例，大致流程可以是 介绍背景=》问题思考=》抽象提炼=》思考总结； 以反馈问题跟进文档为例，可以是 问题表现》问题分析》出现原因》修复方案》后续问题》质量监控
abbitMq 技术文档 AMQP简介 AMQP即Advanced Message Queuing Protocol，高级消息队列协议，是面向消息中间件设计的应用层协议的一个开放标准。...在Documentation下的Server下的Management是关于配置这个插件的。...需要注意的是：关于绑定键有两种特殊的情况。 *可以匹配一个标识符。 #可以匹配0个或多个标识符。 5.6.2 图解 我们准备发送关于动物的消息。...Q2想要知道关于rabbit的一切以及关于懒惰的动物的一切。 一个附带quick.orange.rabbit的选择键的消息将会被转发到两个队列。...7.4 镜像模式配置 7.4.1 增加负载均衡器 关于负载均衡器，商业的比如F5的BIG-IP，Radware的AppDirector，是硬件架构的产品，可以实现很高的处理能力。
Kafka 技术文档 Kafka创建背景 Kafka是一个消息系统，原本开发自LinkedIn，用作LinkedIn的活动流（Activity Stream）和运营数据处理管道（Pipeline）的基础...集成的代码，包括hadoop-consumer和hadoop-producer core目录: Kafka的核心代码，也是作者后面重点要学习的部分 examples目录:Kafka样例代码，例如如何使用Java...properties） --7564 ttys002 0:15.91 --/System/Library/Frameworks/JavaVM.framework/Versions/1.6/Home/bin/java...localhost:2181 --from-beginning --topic my-replicated-topic --my test message 1 --my test message 2 各项技术...大多数消息系统声称可以做到“精确的一次”，但是仔细阅读它们的的文档可以看到里面存在误导，比如没有说明当consumer或producer失败时怎么样，或者当有多个consumer并行时怎么样，或写入硬盘的数据丢失时又会怎么样
（2）利用初始化的模型将语料转化为对象的向量 1）TFIDF（词频逆文档频率） 2）LSI（潜在语义索引） 将词袋模型或TFIDF空间映射到低维度的潜在空间，推荐200-500为金标准，在达观数据的长文本分类中...LSI可以进行增量训练，只要有新文档可以一直输入模型当中，通过add_document方法。如果python报memoryerror，那就是内存不够了，需要降低维度。...3)LDA（隐含狄利克雷分配） LDA是LSA的概率扩展，也是向低纬度转化的方式 4)RP(随即映射) 目的在于减小空维度，通过随机性，近似的到文档之间的TFIDF距离，但对于大数据量很慢...4.相似度匹配 在得到文章对应的主题向量以后，就可以进行相似性匹配，将多个文档遍历进行匹配，然后排序选择相似度最大的文章，取其在训练集中对应的分类编号，作为测试文档的类别。
1.5 关 于 Java 的常见误解 在结束本章之前， 我们列出了一些关于 Java 的常见误解， 同时给出了解释。...实际上， 很多 Java 程序都在 Web 服务器上运行并生成用于网页的代码。 Java 程序是主要的安全风险对于早期的 Java， 有过关于安全系统失效的报道，曾经一度引起公众哗然。...研究人员将这视为一种挑战， 即努力找出 Java 的漏洞，对 applet 安全模型的强度和复杂度发起挑战。随 后，人们很快就解决了引发问题的所有技术因素。...有些系统管理员甚至在公司浏览器中禁用了 Java, 而同时却允许用户下载可执行文件和Word 文档，实际上，这些带来的风险远甚于使用 Java。...与 Java applet 相比，JavaScript 更紧密地与浏览器集成在一起。特别是 JavaScript 程序可以修改正在显示的文档， 而 applet 只能在有限的区域内控制外观。
markdown编辑器的语法提示使用蓝色与黑色区分度太低，比如 * 就看不清楚是啥颜色。
关于文档编写的几个思维 近期重新组织了好几篇技术文档，把其中的一些感悟提炼出来。...按照现有文档完成后的文档输出如何组织？ 0. 程序员如何看待文档？ 程序员一定会是接触各种各样的技术文档，文档写的好与不好，大致都能区分出来。...但是对于自己写的文档却可以容忍 “丑陋” 、“难以理解”等...... 对技术、代码可以修改、修改、再修改，优化、优化、再优化.........比如个人最崇拜的世界 Python 技术排名第五的作者： kennethreitz，他的开源作品：requests 再比如：开源 web 框架 Django 这两个项目的文档堪称是教科书式文档示例。...pic_2.png 这里有一篇中文技术文档写作规范参考：阮一峰：中文技术文档写作规范 标题： 我只谈论一点：标题原则上存在六级，即一级、二级、三级、四级、五级和六级标题。
答：“去看文档” “Django的文档都是英文，我看不下去，怎么办” 答：“bla bla bla…. 关于英文的重要性” “Django的文档那么多，我是不是都得看完才行？”...先来分享下我的经历 在我刚从Java转到Python时就直接接触的Django框架，当时同事给我推荐过一本Django的英文书《Practical Django Projects》,当时看了几页，因为速度太慢...除了在这样被鄙视的的状态下去看文档的，自己也尝试过去挨篇读文档，唯一的收获就是大概知道有哪些东西了，附带的收获就是对文档这东西不那么陌生了。...无论是翻译还是别人（或者我）写的关于Django某一点的应用，都会随着Django版本的更新变得不再实用。并且所有这些资料的最终来源都是在官方文档上，因此不如直接从源头上汲取营养。...另外还得说说英文阅读的事儿，这是任何开发人员都绕不过的坎，关于英文对程序员的重要性网上已经有很多论述了，我这里不再添加冗余的信息了。
很多技术人自己非常轻视技术文档的书写，然而又时常抱怨文档不完善、质量差、更新不及时… 01 文档的重要性 高质量的文档对于一个组织或团队来说有非常多的益处，比如让代码和API更容易理解、错误更少；...关于文档的重要性，每个技术人或多或少都知道一些，但很多人还是没有写文档的习惯，为什么？...1.像管理代码一样管理文档 对于如何写出好代码，整个技术圈已经有好多经验的总结了，比如书籍《重构》《代码简洁之道》…… 针对各种编程语言，也有相关的规范，比如国外的Google C++规范，国内的阿里Java...落地页的技术难度不高，但要求内容的有效性、完整性和分类清晰。 4.文档Review 在一个组织内，光靠个人去维护文档是不行的，必须得借助群体的智慧。...技术文档也算是文章的一种，所以一般也都会有这三部分，每个部分有其自己的作用，比如第一部分阐述问题，中间部分介绍具体的解决方案，第三部分总结要点。
深感真正做技术，分享技术的人越来越少了，我前段时间成立了一个分享群，旨在能够让大家一起沟通交流，学到更多的东西。而且进群前也已经说了规则，强调要多交流，还是很多人进群潜水，或者发广告。...最近联合了几个运维架构界老朋友，打算做几次地面会议分享，目前还在筹划中，让技术真正落地，帮助新手尽快学会实用技能，是我一直以来的梦想。
因为要转换的十进制有300多位，long都装不下，没有直接可用的函数可以拿来用 王总的方法分享之： 思路：转换10进制字符串为大整数 ，大整数放入字节流，每个字节转换为16进制，有空位补零 代码： import java.math.BigInteger...右击任意目录打开右键菜单,打开"tortoisesvn" => "settings"下的设置窗口 b) 找到"icon overlays"的设置项，将"status cache"设置成"none" java...异常：java.lang.ClassFormatError: Truncated class file 实验了好几次 发现突然之间从自己xp机器上maven build的 class文件 拷贝到服务器上不能跑了...最终发现是因为ssh里选择了将文件作为binary传输造成的，去掉该选项就可以了 org.apache.juli.ClassLoaderLogManager not found JAVA_HOME 没有设置...安装后设置为/usr/local/jdk即可 java.net.UnknownHostException sc-server02: sc-server02: 修改 /etc/hosts 127.0.0.1
Python调试和部署总会碰到各种各样的问题，Python的版本问题，各种包的版本问题，Python的调试和部署快成了一门玄学，这次遭遇到的是FastAPI文档界面无法显示的问题，中间也测试过几种方案。...FastAPI部署后，各页面均正常响应，除了文档页，经查证是FastAPI接口文档中默认使用的是https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.9.0/swagger-ui.css...Actual monkey patch applications.get_swagger_ui_html = swagger_monkey_patch 最后找到一种更佳的方案，选择用FastAPI离线文档方式
关于需求评审 by:授客 QQ：1033553122 1、 传统的软件开发模式中，太过依赖文档，有各种各样的文档，需求说明书，比如市场需求说明书，业务需求说明书， 软件概要说明书，软件详细设计文档等等...，这些文档在追求速度的时代却似乎效用不大，很多时候反而成了负担。...去掉无用的功能定义文档、需求文档可行方法： 想法快速制作成静态的原型->>根据“市场效果反馈”修改原型设计->>用真实数据建立一个动态原型->去除累赘 这样，以实际的界面或原型来说明你要构建一个真正的产品...从这个点出发，我们可以把重心从“需求文档评审”转移到“原型(Demo)评审”,以原型评审为中心，辅以必要的文档说明，作为原型的补充。
# 衡量技术文档好坏的标准是什么 Martin(Bob大叔)曾在《代码整洁之道》一书打趣地说：当你的代码在做 Code Review 时，审查者要是愤怒地吼道： “What the fuck is this...根据所编写的文档，判断主要面向的受众是产品、技术、测试还是商务人员，尽量使用他们所能理解和熟悉的词汇和表达方式来表达。 提供必要的信息。...根据需要编写的技术类型，提供必要的信息，就像摄影拍照一样，有一些约定的摄影构图，例如：均衡式构图、对称式构图、对角线构图、三角形构图、九宫格构图等。...很多技术人员觉得编写文档比写代码还要难，还要头疼。其实写文档和写代码是类似的，很难一开始就写出完美的文档。应该是像写代码一样，一开始写得很丑陋，但没关系，至少有内容了。...# 参考资料 如何写好技术文档? (opens new window) 程序员如何编写高大上且实用的技术文档 (opens new window)
在整个职业生涯中，每个软件工程师都抱怨过文档的质量、数量或者完全缺乏文档。 01 为什么需要写文档？ 高质量文档对工程组织有巨大的好处。代码和api变得更容易理解。...工程师可能会编写shell脚本或Python来运行命令行任务，或者他们可能会用c++编写大部分后端代码，但用Java编写一些中间件代码，等等。每种语言都是工具箱中的一种工具。...软件工程师经常需要编写几种主要类型的文档： 参考文档，包括注释 设计文档； 教程； 概念性文档； 1.参考文档 参考文档是工程师最常编写的文档类型;事实上，他们经常需要每天写一些参考文档。...技术文档得益于三种不同类型的review，每种审查都强调不同的方面： 专业的视角来保证准确性：一般由团队里比较资深的人负责，他们关注的核心点是文档写的对不对，专不专业。...06 文档写作的哲学 下面的部分更多地是关于技术写作最佳实践的论述。
领取专属 10元无门槛券
手把手带您无忧上云
云服务器
ICP备案
实时音视频
云直播
对象存储
