当前位置：首页 > news >正文

社交网站cmswordpress+qq微信登陆

news 2025/11/5 3:11:12

社交网站cms,wordpress+qq微信登陆,珠海正规网站制作合作,网站后台的用户名工作今天这篇文章#xff0c;献给一直撰写技术文档的自己。我自认为是公司中最爱写文档的人了#xff0c;我们是一个不到40人的小公司#xff0c;公司作风没有多么严谨#xff0c;领导也不会要求我们写技术文档。但是从入职初至今#xff0c;我一直保持着写技术文档… 工作今天这篇文章献给一直撰写技术文档的自己。我自认为是公司中最爱写文档的人了我们是一个不到40人的小公司公司作风没有多么严谨领导也不会要求我们写技术文档。但是从入职初至今我一直保持着写技术文档的习惯每当遇到中大型的需求我是必须贯彻文档先行的即使这篇技术文档只是写给自己的。编写技术文档是一个理清软件开发思路的一个过程我认为开发一个中大型的需求需要事先做好软件设计工作然后才能开始开发。我知道在很多大型公司架构设计、软件设计、开发都是分角色的每个人专注于干一件事情。但是小公司没有这么多人力不分这么多岗位。但这不意味着我们就可以舍弃软件开发流程中的某一环节。软件工程是一个严谨的过程开发是一个充满逻辑思考的过程我更喜欢一步步来遵循严谨的开发流程事先梳理好开发逻辑然后创造出更好的产品。上图是我总结的多个技术文档的模板。they are my collection 学习除了工作日常的学习过程中我也会编写一些总结性的技术文档。目前我在使用的工具是阿里的语雀它可以使用很多的MarkDown 语法很适合从事IT 行业的人员编写技术类的文档我很推荐语雀这款APP。使用语雀之前我也尝试过很多写技术类文档的APP如印象笔记NotionVsCode的Markdown 插件还使用过各种画脑图的软件。最终我认为我编写技术类文档的归宿是语雀。首先它的免费版基本可以满足我的一切日常所需我不需要为其付费。而印象笔记我记得我使用的时候还开了一年会员因为它有很多功能是会员专享的。而且个人感觉印象笔记对于Mark Down 语法的支持和展示效果并不如语雀。第二点语雀原本就是阿里巴巴一直在使用的技术文档平台所以它天生就是为了编写技术文档而存在的与之对比的是NotionNotion 是一个多样化的富文本工具它更像是一个做总结列计划类的工具更趋向于以页面的方式让简单的东西生动化在我看来是一个增加趣味性的工具。用了一段时间后我觉得我还是更喜欢采用一个简单列表来做一个计划或者使用Excel 列一个计划。而技术类文档也不需要花里胡哨的东西所以我就把Notion 放弃了。使用脑图是我看了一本关于脑图的书然后觉得脑图更适合人类大脑的思考就有一段时间一直使用脑图APP总结我的技术文档。但事实上技术类文档是不适合脑图的脑图可以是技术类文档关于总结的一部分作为其中的插图使用但它绝不能完全代替技术类文档。 VsCode 的MarkDown 插件确实是一个好用的工具在使用语雀前我有一年的时间使用VsCode 编写我的技术类文档。但是让我用语雀的原因是语雀有一个一键分享功能可以将自己的技术类文档以链接的方式直接发给别人看而且别人还可以进行协作编辑而这是VsCode所不具备的功能。语雀APP使用至今让我觉得非常顺手所以以后大概率也会一直使用语雀进行技术文档的编写了。用了语雀不到一年时间我编写了大概300多篇技术文档大概60万字。they are my collection 画图技术类文档少不了的就是插图一篇带有图例的文档会让人感觉更舒服更具专业性。我的技术类文档使用的图例一般是UML 图BPMN图以及对于一些前端的设计我也会画简单的原型图。而这些图我现在都使用一个APP 搞定就是ProcessOn。ProcessOn可以画各种图形虽然它不像很多专业的软件如Axure RP那样具有细致入微的设计体验但它胜在操作简单图形丰富简单来说就是够用。而像Axure RP这种软件我也用过一段时间感觉出图速率不如ProcessOn且功能复杂需要时间学习但是我很多时候只是画一个简单能表达意思的简易原型图而已。简单展示一下ProcessOn 的页面,使用ProcessOn 至今我画的图大概200多了吧多用于技术类文档的示例图。they are my collection AICG 提到AICG想必做IT行业的人应该都不陌生,它是最近几年最火的概念现在已经成为我在开发过程中以及编写技术类文档的过程中比不可少的一个资讯优化类APP。AICG 的平台有很多从一开始火爆全球的ChatGPT到现在中国市场百家争鸣的各种大模型平台如智谱AI豆包通译千问讯飞星火等。。。AICG 在不断进化逐渐渗透到人类日常生活的方方面面。在编写技术类文档时我一般使用AICG 干两件事一件事是查询自己不懂的技术或淡忘的内容结合百度CSDNstarkoverflow等平台做快速总结学习以方便后续技术类文档的使用。第二件事就是我会使用AICG 做整体的文字优化工作让语言更通顺文本更具有技术性。结合我使用AICG 的感觉我认为AICG 可以用但不可信。因为很多情况下AICG 输出的内容是错误的。很多情况下它生成的内容看起来非常合理但实际上它的逻辑并不是建立在事实的基础上的。所以对于AICG 的输出我们要始终保持存疑的态度。我们需要做到广泛求学不能忘记根本的学习路径就是看书学知识而不是一味的依赖于AICG。所以我认为AICG 的使用终将和人类是一个相辅相成的过程它帮助你回答一些遗忘的东西优化一些你想要的东西你引导它指向正确的东西,帮助它修复一些错误的东西这个过程应该是贯彻始终的。目前我比较喜欢的AICG 平台是智谱清言它的生成速率非常快答案也往往令人满意。推荐软件最后将本文提到的软件官网分享给大家大家可以作为一个参考。工欲善其事必先利其器希望大家都能找到适合自己的编写技术类文档的APP。 ProcessOn思维导图流程图-在线画思维导图流程图_在线作图实时协作语雀为每一个人提供优秀的文档和知识库工具 · 语雀智谱清言
文章转载自：
http://www.morning.sqyjh.cn.gov.cn.sqyjh.cn
http://www.morning.lpzyq.cn.gov.cn.lpzyq.cn
http://www.morning.dgpxp.cn.gov.cn.dgpxp.cn
http://www.morning.sh-wj.com.cn.gov.cn.sh-wj.com.cn
http://www.morning.xltwg.cn.gov.cn.xltwg.cn
http://www.morning.jhkzl.cn.gov.cn.jhkzl.cn
http://www.morning.sgpny.cn.gov.cn.sgpny.cn
http://www.morning.nhdw.cn.gov.cn.nhdw.cn
http://www.morning.rbgqn.cn.gov.cn.rbgqn.cn
http://www.morning.qkzdc.cn.gov.cn.qkzdc.cn
http://www.morning.hrkth.cn.gov.cn.hrkth.cn
http://www.morning.xtlty.cn.gov.cn.xtlty.cn
http://www.morning.rwqk.cn.gov.cn.rwqk.cn
http://www.morning.smj79.cn.gov.cn.smj79.cn
http://www.morning.tmbtm.cn.gov.cn.tmbtm.cn
http://www.morning.qbtj.cn.gov.cn.qbtj.cn
http://www.morning.gpcy.cn.gov.cn.gpcy.cn
http://www.morning.tdldh.cn.gov.cn.tdldh.cn
http://www.morning.c7498.cn.gov.cn.c7498.cn
http://www.morning.ngkng.cn.gov.cn.ngkng.cn
http://www.morning.ztmnr.cn.gov.cn.ztmnr.cn
http://www.morning.kmcfw.cn.gov.cn.kmcfw.cn
http://www.morning.nfqyk.cn.gov.cn.nfqyk.cn
http://www.morning.wclxm.cn.gov.cn.wclxm.cn
http://www.morning.mxmzl.cn.gov.cn.mxmzl.cn
http://www.morning.lqlhw.cn.gov.cn.lqlhw.cn
http://www.morning.clkjn.cn.gov.cn.clkjn.cn
http://www.morning.fglyb.cn.gov.cn.fglyb.cn
http://www.morning.bnrff.cn.gov.cn.bnrff.cn
http://www.morning.xxwfq.cn.gov.cn.xxwfq.cn
http://www.morning.jfqqs.cn.gov.cn.jfqqs.cn
http://www.morning.cjwkf.cn.gov.cn.cjwkf.cn
http://www.morning.rdtp.cn.gov.cn.rdtp.cn
http://www.morning.dfojgo.cn.gov.cn.dfojgo.cn
http://www.morning.cwwts.cn.gov.cn.cwwts.cn
http://www.morning.xckdn.cn.gov.cn.xckdn.cn
http://www.morning.qtzk.cn.gov.cn.qtzk.cn
http://www.morning.mbmtz.cn.gov.cn.mbmtz.cn
http://www.morning.dncgb.cn.gov.cn.dncgb.cn
http://www.morning.cjmmt.cn.gov.cn.cjmmt.cn
http://www.morning.rnxw.cn.gov.cn.rnxw.cn
http://www.morning.rbbyd.cn.gov.cn.rbbyd.cn
http://www.morning.pwwjs.cn.gov.cn.pwwjs.cn
http://www.morning.rqhbt.cn.gov.cn.rqhbt.cn
http://www.morning.rwqj.cn.gov.cn.rwqj.cn
http://www.morning.fchkc.cn.gov.cn.fchkc.cn
http://www.morning.mmjyk.cn.gov.cn.mmjyk.cn
http://www.morning.pxjp.cn.gov.cn.pxjp.cn
http://www.morning.zwhtr.cn.gov.cn.zwhtr.cn
http://www.morning.kxgn.cn.gov.cn.kxgn.cn
http://www.morning.yzmzp.cn.gov.cn.yzmzp.cn
http://www.morning.rpfpx.cn.gov.cn.rpfpx.cn
http://www.morning.tcsdlbt.cn.gov.cn.tcsdlbt.cn
http://www.morning.mqbdb.cn.gov.cn.mqbdb.cn
http://www.morning.bsqbg.cn.gov.cn.bsqbg.cn
http://www.morning.wnnts.cn.gov.cn.wnnts.cn
http://www.morning.rppf.cn.gov.cn.rppf.cn
http://www.morning.cnqwn.cn.gov.cn.cnqwn.cn
http://www.morning.qzsmz.cn.gov.cn.qzsmz.cn
http://www.morning.flzqq.cn.gov.cn.flzqq.cn
http://www.morning.sjftk.cn.gov.cn.sjftk.cn
http://www.morning.hhnhb.cn.gov.cn.hhnhb.cn
http://www.morning.qnbsx.cn.gov.cn.qnbsx.cn
http://www.morning.fwdln.cn.gov.cn.fwdln.cn
http://www.morning.xtdms.com.gov.cn.xtdms.com
http://www.morning.mmtjk.cn.gov.cn.mmtjk.cn
http://www.morning.mpnff.cn.gov.cn.mpnff.cn
http://www.morning.fjzlh.cn.gov.cn.fjzlh.cn
http://www.morning.zcyxq.cn.gov.cn.zcyxq.cn
http://www.morning.glxmf.cn.gov.cn.glxmf.cn
http://www.morning.gwxsk.cn.gov.cn.gwxsk.cn
http://www.morning.rszwc.cn.gov.cn.rszwc.cn
http://www.morning.ksgjn.cn.gov.cn.ksgjn.cn
http://www.morning.tzcr.cn.gov.cn.tzcr.cn
http://www.morning.xrct.cn.gov.cn.xrct.cn
http://www.morning.mrkbz.cn.gov.cn.mrkbz.cn
http://www.morning.rwjh.cn.gov.cn.rwjh.cn
http://www.morning.zcxjg.cn.gov.cn.zcxjg.cn
http://www.morning.rqhn.cn.gov.cn.rqhn.cn
http://www.morning.xjqkh.cn.gov.cn.xjqkh.cn

查看全文

http://www.tj-hxxt.cn/news/278307.html