首先,特别感谢这位热心读者,开诚布公地与我分享感受,提出宝贵意见,帮助我做得更好。
很多人说,不知道怎么写文档,都是凭着感觉写。 网上也很少有资料,教你写文档。这已经影响了中文软件的发展。 英语世界里,文档非常受重视,许多公司和组织都有自己的文档规范,清楚地规定写作要求,比如微软、M
关于文档编写的几个思维 近期重新组织了好几篇技术文档,把其中的一些感悟提炼出来。 文档为达到容易理解和操作的程度,对大量的语言重新组织,内容的不同呈现,借助辅助工具等一系列操作,本文就是剖析整个流程 全文主要的流程是: 编写文档前,准备工作有哪些? 根据现有文档的问题是? 语言的组织和内容的不同呈现方式有哪些? 按照现有文档完成后的文档输出如何组织? 0. 程序员如何看待文档? 程序员一定会是接触各种各样的技术文档,文档写的好与不好,大致都能区分出来。 但是对于自己写的文档却可以容忍 “丑陋” 、“难以理解
无论您是想要统一中文排版风格、改进文字质量还是提高技术文章的清晰度与易读性,这里推荐的几个开源项目都能满足您的需求。它们提供了详细的规范和指南,帮助您正确使用空格、标点符号以及中英文之间的排版等方面。这些项目还支持多种文件格式,并且具有灵活性和可定制性,让您能够根据自己的需要进行调整。无论您是初学者还是经验丰富的作者,在撰写中文文案或技术文档时,这些开源项目都将成为不可或缺的资源。
在之前的文章我整理了中文 Markdown 的编写规范,但是在日常写作当中,还是避免不了出现一些不满足规范的情况,这个时候就需要一款检查工具。在 Github 上浏览的时候发现了这款 lint-md-cli 命令行工具,基本解决了我的问题。
总体而言,技术写作需要广泛的技能组合,包括写作技巧、技术知识、研究技巧、工具技能、设计技巧、注重细节、组织能力、科技知识、语言能力和书面沟通技巧。具备这些技能的技术写作者可以创建准确、清晰、易于理解的技术文档,帮助读者理解复杂的技术概念并完成任务。
很多技术人自己非常轻视技术文档的书写,然而又时常抱怨文档不完善、质量差、更新不及时…
最近在带大家做新项目,欢迎参与 大家好,我是鲏。 很多初入职场的程序员朋友,可能很长一段时间都在重复下面的过程: 组长分配一个任务 --> 你埋头写代码 --> 收到 Bug 反馈 --> 你埋头改代码 ... 有位刚入职的学弟就是这样,虽然每次的工作都能按时完成,但总感觉自己是一个 “写代码的机器”(听别人的,负责把需求翻译成代码),也没有什么成长。 快别这样了!写代码真的只是唯一能做的吗? 需求的背景你清楚了么?需求方是谁?为什么提这个需求? 为什么要这么做需求,还有其他的方法么? 这条需求背后是关于哪
技术写作是指用简单易懂的语言向特定受众解释复杂概念的一种写作形式。这种写作形式通常用于工程、计算机硬件和软件、金融、消费电子和生物技术等领域。技术作者的主要目标是简化复杂信息并以清晰简洁的方式呈现。技术作者的职责可能包括创建操作指南、用户手册、常见问题解答页面、期刊论文和其他技术内容,以帮助用户理解。最终目标是使用户能够轻松理解和掌握新产品或概念。
文档写的清楚,思路就更加清晰,也会让同事高看你一眼,多梳理业务也有很大帮助。
程序员最讨厌两类人,一类是不写文档的人,一类是让自己写文档的人。但其实,一篇上下文详尽、边界清晰的文档,能够前置性地解决很多问题,避免因为信息差而带来的各种来回追问、扯皮。 写技术文档是开发者的义务,它和写可读代码一样重要,它也可以体现个人做事态度、逻辑思考能力。本篇文章作者将体系化地教会你,如何写文档,如何写好文档。
产品经理对需求文档基本是驾轻就熟信手拈来,但是大多数程序猿写技术文档却显得不够专业。
开始接触开源社区的一个方法就是写关于它的文章。你可以贡献技术文档,分享你如何使用软件,或者为我们社区写一篇文章。但是开始写作说起来容易做起来难。我听到的最常见的两个不写文章的借口是:“我没有什么新东西可写”和“我不是一个好的作者”。我在这里是为了打破这两个误区。
除了代码中使用的符号以及一些特殊情况外,请将英文(半角)符号替换成中文(大部分为全角)符号。
每当接手一个别人开发好的模块或者项目,看着那些没有写注释的代码,文档呢?!文档呢?!Show me the doc !!
所谓影响力,指的是在某个领域或行业的知名度、号召力,它是一种无形的优质资产,是我们在面对激烈的竞争环境下不被淘汰的法宝。
据说,技术内容领域、传播领域的专家和决策者们会在中国技术传播大会「tcworld China 2022」大会上分享心得。作为一名技术文档工程师,本着了解相关行业的发展趋势和提升自我为 NebulaGraph 社区创造更大价值的心态,参加了此次大会。
macOS 上优秀的写作工具比比皆是——Ulysses、MWeb、Bear、Editorial 等等,它们兼具记笔记、Markdown 写作多重功能定位。 而在大微软 Windows 平台上,出色的写作应用真的需要花点时间、认真收集才能有所收获,这份写作工具合集均有以下的特点: 简单又简洁,功能和应用界面以追求「轻」作为目标,合集不会出现类 wiki 的应用; 支持 Markdown 语法,这一功能特性已经成为写作者的创作趋势,聚焦写作本身,再提供简洁的语法格式(我常用的 Knowte、Evernote、
内容研究涉及对特定主题进行系统的调查,以收集可靠和相关的信息。这个过程对于技术作者来说至关重要,因为它有助于生成有价值的、准确的、信息丰富的和引人入胜的内容。它超越了基本的互联网搜索,包括阅读技术文档、采访专家、进行调查和分析数据。内容研究应以战略方式进行,考虑信息的用途、目标受众和要传达的关键信息。一个执行良好的内容研究过程可以帮助技术作者生成既清晰又简洁的高质量内容。
在技术写作领域,“工具”是指技术写作者用于创建、管理和发布高质量技术文档的各种软件和应用程序。这包括文字处理器、桌面出版应用程序、XML 编辑器、内容管理系统等等。一些技术写作者常用的工具示例包括 Microsoft Word、WPS、Typora、Notion、印象笔记、GitHub、飞书云文档 和 VSCode 等。这些工具通过允许文档版本控制、启用协作、提供用于一致格式设置的模板、提供管理大量内容的功能,甚至提供将文档翻译成多种语言的功能,从而提高了生产力。工具的选择取决于技术写作者或其工作的组织的具体需求和工作流程。
作为一名技术写作者,遵守既定的最佳实践有助于确保您的工作的一致性、清晰性和整体质量。一些常见的最佳实践包括:
软件开发工程师是解决问题的人。他们使用逻辑推理来解码谜题,越过障碍并创建解决方案。开发人员受帮助其他人的动力驱使,因此当他们开发的解决方案令其他人的生活变得更好时,他们会从中得到满足感。尽管一些人认为软件开发都是有关逻辑推理的,与艺术表现无关,但该角色本身是极要求创造性的,最成功的开发人员是那些具有想象力,聪明的并且脑子灵活的人。
在多语言环境下实现技术文档的实时同步是一项重要的任务,特别是在全球化的企业环境中,确保文档的准确性和一致性对于维护品牌形象和提高客户满意度至关重要。下面是一些思路和技巧:
Draven 是来自 Shopee Engineering Infrastructure 团队的后端工程师。在工作之余,他还拥有另一重身份——技术写作者。
随着组织逐渐成熟的DevOps实践,是时候让技术写手成为团队中更大的一部分了。企业通常会将技术作者的角色排除在DevOps讨论之外。甚至营销部门也加入了一些以开发为先的组织的讨论,那么为什么作者不加入
本文基于我十多年程序员生涯观察,落笔始于 2019 年学习怎么带领团队新人时,在此之前我一直在想,如果当年有人告诉我这些道理,我是不是可以发展得更好,也少一些纠结。
最近测试项目开发完,本来自测了几天直接上线(基本都是冒烟用例和正向的功能用例),因为是个内部项目,所以没想做很严格的测试。但这周刚好腾出来测试人手了,专门安排了一个Web端测试童鞋来测试。还是发现了一些「BUG」的,下面分享一下自己写过的BUG。
我从2008年开始在博客园写技术类文档,最早的时候不知道Markdown,而且博客园也没有提供Markdown编辑器,当时都采用富文本编辑器来写,每次调整格式都需要挺长时间。当时笔记软件还用微软的OneNote,因为也不支持Markdown,因此用的也还算平稳。
今天,猫头虎博主要带领大家深入了解Markdown编辑器,从基本介绍到深入分析几款主流和值得推荐的编辑器。不论你是编程新手或是资深开发者,本文将帮助你找到最适合你的Markdown编辑器。我们将围绕易用性、跨平台特性、实时预览等关键SEO词条展开,旨在提供一个既准确又易读的技术博客文章。
很多人都知道ChatGPT很火很强,几乎无所不能,但跨越了重重门槛之才有机会使用的时候却有些迷茫,一时间不知道如何使用它。如果你就是把他当作一个普通的智能助手来看待,那与小爱同学有什么区别?甚至还差劲些,因为各大厂商的智能助手起码还知道实时的时间和天气情况,而ChatGPT却一无所知,那么,什么样的使用姿势才是正确且高效的呢?
最近在和一些朋友交流中,都发现大家工作一段时间后,进入了一个迷茫期。想学习一些新的东西,不知道怎么去学习?或者说不知道是否该去学习这门技术。更有一种情况是,一些朋友在选择学习一门技术之后,又开始学习另外一门技术。从实际的情况中,这种做法体现了你自己也没想好你究竟需要学习什么。
工欲善其事,必先利其器。使用LaTex写作感觉和写代码差不多,都需要一个好的IDE,Coding我喜欢用VS code,sublime。而LaTex写作,因为我又不是win用户,word用起来稍显费劲,所以着实摸索了一阵子。
前端开发规范 代码质量开发规范 代码风格格式化规范 git工作流程提交规范 项目组织规范 项目模板规范 通用脚手架开发 技术文档保留规范 异常处理规范 前后端协作规范 双周分享 技术分享落地留存规范 新人培训规范 新人入职流程规范 前期准备 开发工具vscode vscode所需插件: Vetur、ESLint、Prettir-Code formatter、Prettier ESLint 代码质量规范 Eslint 项目目录配置.eslintrc.js文件用于项目规范、规范可以一起定义或者使用行业标准规范
Visual Studio Code (VSCode) 是微软推出的一款开源编辑器,使用 Electron 打造,与 Atom 齐名,不过随着 Atom 社区的渐渐缩小,VSCode 的影响力开始越来越大了。VSCode 内置了 Markdown 语言及预览的支持,很适合用于编辑 Markdown 文档。
文章不是简单的的Ctrl C与V,而是一个字一个标点符号慢慢写出来的。我认为这才是是对读者的负责,本教程由技术爱好者成笑笑(博客:http://www.chengxiaoxiao.com/)写作完成。如有转载,请声明出处。
不管你是有多年编程经验的程序员,亦或是你刚刚开始学习编程,如果你在读这篇文章,那么你已经有了另一门语言的技能:英语技能。
又一写作利器,这个版本改动非常大,算是第一个可以胜任日常任务的版本吧。如果你有写电子书、技术文档、博客、公众号、专业论文等,不妨试试这个写作软件。免费下载 https://ivarptr.github
对于很多程序员或写文作的人来说, 一定知道Markdown这种格式. 使用Markdown来编写文章非常方便, 优雅. 让你专注于内容, 而不用纠结格式.
这里面既要熟悉公司的企业文化、产品业务、技术框架、系统代码,还要处理好身边的同事关系。。。。
哈喽,大家好,我是小马,去年年底,我开通了微信公众号“JS 酷”,也开始陆陆续续开始写文章, 发到微信公众号,作为一名程序员,我酷爱 Markdown,相信很多朋友跟我一样, 也经常会有写技术文档的需求。Markdown 由于语法简洁、使用方便、深受广大程序员们的喜爱。
MarkText号称下一代Markdown编辑器,是一款简单易用的开源编辑器,支持Linux、MacOS和Windows系统。MarkText在Github上已经有26.9k+Star,可见其是非常流行的!
Markdown 是一种轻量级的标记语言,它允许人们使用易读易写的纯文本格式编写文档,借助可实现快速排版且转换成格式丰富的 HTML 页面。目前被越来越多的写作爱好者及工作者使用。它在写作、博客、文档等领域得到了广泛应用,因其简洁、易读、易写的特点而备受欢迎,一旦掌握这种标记语言,将极大提高效率。但是若需要复杂排版如左右对齐缩进等,还是选择 word 等专业软件。
学习一门新的编程语言 当熟练了Java之后,再去学习新的编程语言,比如Python,这个时候不仅能够很快的学习好Python,Java语言能力也在迅速提高 因为语言是相通的,当学习Python的时候,会带着和Java相比较的心去学,这个时候,不仅学习了Python,也加深了对Java的理解 尝试独立完成一个项目 独立完整地完成一个项目,可以更全面的了解项目的构成 重温经典书籍 意识到操作系统,计算机网络,编译原理,数据结构与算法,数据库知识的重要性 动物书: O'Reilly出版的系列书 犀牛书 蝴蝶书
来到一个新的环境,发现周围好多同事都是用word写技术文档的,觉得有必要将markdown这么好的东西介绍给大家。同时为了方便各位技术同仁写技术博文,推荐一下hexo,真的很方便。 markdown简介 Markdown 是一种「电子邮件」风格的「标记语言」,很适合写技术文档。总结下来,它有如下优点: 纯文本,所以兼容性极强,可以用所有文本编辑器打开。 让你专注于文字而不是排版。 格式转换方便,Markdown 的文本你可以轻松转换为 html、电子书等。 Markdown 的标记语法有极好的可读性。 Ma
本文由MoonWebTeam团队的owen、四月一日、HNA、challen、生皮土豆、janse合作编辑而成,部分内容来自于网络、参考文章,如有侵权请联系删除。 引言 很多人都有写文章的想法,但每次提起笔,却不知从何下手,觉得很难,本文将手把手教你如何写好一篇技术文章,为大家带来最全面、最细致、最易上手的终极指南,从此不再怕写文章。 1 为什么要写文章 思考“Why”比学习“How”更重要,在开始之前,我们从『利己』和『利他』两个角度分别来分析为什么要写文章: 1.1 对作者的好处 1.1.1 复盘学习成
这期给大家介绍一下Prompt也就是提示词的使用,让GPT更准确的回答我们的问题。
自从ChatGPT和Midjourney爆火以来,似乎每个人都陷入到一种战战兢兢的精神状态中,担心自己正在,或者将要被AI取代。
随着机器人技术的快速发展,户外机器人在农业、环境监测、搜索与救援等领域的应用日益广泛。为了实现高效、准确的区域覆盖,机器人需要搭载先进的区域覆盖算法。然而,在实际环境中直接测试这些算法往往成本高昂且风险较大。因此,设计一个能够模拟真实户外环境的仿真测试平台,对于算法的开发、验证与优化至关重要。
类似hexo一个极简的静态网站生成器,用来写技术文档不能在爽。当然搭建成博客也不成问题。
在大多数软件工程师对编写、使用和维护代码的抱怨中,一个常见的问题是缺乏高质量的文档。缺乏文档有什么副作用呢?当遇到一个bug时,这个缩写是什么意思?这份文件是最新的吗?在整个职业生涯中,每个软件工程师
领取专属 10元无门槛券
手把手带您无忧上云