技术写作过程:如何写出好的技术文章

  • 💂 个人网站:【海拥】【摸鱼游戏】【神级源码资源网】
  • 🤟 前端学习课程:👉【28个案例趣学前端】【400个JS面试题】
  • 💅 想寻找共同学习交流、摸鱼划水的小伙伴,请点击【摸鱼学习交流群】

2020 年,我加入了技术写作,在CSDN这里我撰写了近 500 篇技术文章,并在网上赚了一些零花钱。根据我的经验写一篇好的技术文章是将复杂的概念分解成简单易懂的语言的文章。

作为技术作者,要将复杂的概念分解为简单易懂的语言,你需要:

首先,了解你正在写的主题。
其次,了解你的写作对象。
然后,了解如何构建文章以将您的信息传递给读者。
最后,知道如何在写作中使用正确的语气。

以下是我将介绍的技术写作过程中的步骤:

目录

    • 第 1 步:研究
    • 第 2 步:准备写作
    • 第 3 步:撰写初稿
    • 第 4 步:初稿审查
    • 第 5 步:编辑和修改
    • 第 6 步:最终稿的校对和批准
    • 第 7 步:发布完成的文章
    • 结论
      • ⭐️ 好书推荐

第 1 步:研究

首先,对你正在撰写的主题进行搜索,并查看与该主题相关的文章。在查看文章时,做笔记以更好地理解主题。

此外,你可以向 ChatGPT 询问有关该主题的信息。然后将你从 ChatGPT 获得的信息与你从 Google 搜索获得的信息进行比较。

其次,确定您要撰写的主题的格式和结构。

文章结构的类型

技术博客写作中有两种类型的技术文章。

  • 程序性文章:这些文章引导读者逐步完成任务。
  • 概念文章:这些文章帮助读者深入理解主题,为进一步学习打下基础。

第三,确定您将要撰写的主题的目标受众。

确定目标受众的最简单方法是确定您的受众需要学习什么。

在您将要撰写的技术文章中写下您的目标受众需要学习的所有内容的列表。

第 2 步:准备写作

首先,确定您将要撰写的文章的目的或目标。

在第一步中确定您的受众将帮助您确定文章的目标。

文章的目标可以是帮助读者学习一些东西或解决一个问题。

其次,创建文章大纲。

简而言之,大纲是一篇完成的文章的骨架,它映射了您将在文章中涵盖的主题。

大纲提供了一个结构,可确保您的想法逻辑清晰。

在第一步中确定文章格式和结构将帮助您创建文章大纲。

注意:确定文章目标并创建大纲后,如果是用户的工作,您可以将文章发送给用户以获得反馈,以确保您在同一页面上。

第 3 步:撰写初稿

首先,在标题中包含文章的目标。以下是如何格式化标签,

标题格式

如何使用<软件或技术>

例子

如何使用 JavaScript 创建计算器

其次,开始写文章介绍。每篇文章的引言应有1至3段。

一个好的介绍应该回答的问题

  • 解决的问题是什么?
  • 这个问题的解决方案是什么?
  • 读者会学到什么?

第三,写前提条件。先决条件的目的是准确说明 读者在学习当前教程之前应该具备或做的事情。

该格式是一个列表,读者可以将其用作清单。每个点都必须链接到涵盖必要内容的现有教程或官方软件文档。

这使您可以依赖已知有效的现有内容,而不是从头开始。

第四,逐步开始撰写文章正文。这些步骤是文章的一部分,您在其中描述读者需要做什么以及为什么。

一个步骤包含命令、代码清单和文件,这些文件解释了 要做什么 以及 为什么要这样做

最后,写下文章的结论。文章的结论应该总结读者通过遵循您的教程所学到的或完成的内容。

第 4 步:初稿审查

写完初稿后,将其发送给用户、主题专家或对你所写主题非常了解的人进行审阅。

由用户或主题专家审阅草稿可确保文章在技术上准确并符合文章的目标。

第 5 步:编辑和修改

编辑和修改是将审阅过的草稿塑造成最终草稿的地方。确保在写作和编辑之间休息一下。休息一下将使您能够以全新的眼光看待您的工作。

您可以在编辑过程中使用一些工具来检查拼写、语法、样式和标点符号错误。

第 6 步:最终稿的校对和批准

校对你的最终草稿是在你完成写作但尚未准备好发布或将其交给用户时进行的。

在这里你通过你的文章来校对:

  • 任何拼写错误
  • 语法错误
  • 错别字
  • 格式错误
  • 结构或语法不正确

校对终稿后,发给用户最后审阅和批准。

第 7 步:发布完成的文章

如果对最终草案不再做任何更改,用户将发布文章。如果是个人文章,您可以将其发布在你的博客或免费的开发者博客平台上,例如:

  • CSDN
  • 掘金
  • 知乎
  • 牛客
  • 华为云开发者
  • 阿里云开发者
  • 腾讯云开发者
  • InfoQ
  • 51CTO
  • 思否
  • 博客园
  • 开源中国
  • 公众号
  • 个人网站
  • 等等…

结论

在本文中,你已经学会了如何一步一步地写出一篇好的技术文章。如果您喜欢这篇文章,给个点赞与关注吧。

⭐️ 好书推荐

《RHCSA/RHCE8红帽Linux认证学习教程》

在这里插入图片描述

【内容简介】

本书从零基础开始讲解,系统介绍了RHCE8的相关知识,以帮助读者快速了解及熟练掌握RHCE8的相关操作,是一本高品质的RHCE认证的学习书籍。本书分为9篇,共35章。第1篇主要介绍基本配置;第2篇主要介绍用户及权限管理;第3篇主要介绍网络相关配置;第4篇主要介绍存储管理;第5篇主要介绍系统管理;第6篇主要介绍软件管理;第7篇主要介绍安全管理;第8篇主要介绍容器管理;第9篇主要介绍自动化管理工具ansible的使用。

📚 京东自营购买链接:《RHCSA/RHCE8红帽Linux认证学习教程》

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.rhkb.cn/news/20069.html

如若内容造成侵权/违法违规/事实不符,请联系长河编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

突破传统,AI在加速“孵化”你的数字人

&#x1f482; 个人网站:【海拥】【游戏大全】【神级源码资源网】&#x1f91f; 前端学习课程&#xff1a;&#x1f449;【28个案例趣学前端】【400个JS面试题】&#x1f485; 寻找学习交流、摸鱼划水的小伙伴&#xff0c;请点击【摸鱼学习交流群】 目录 背景数字人的定义数字人…

37岁,公司把整组都裁了,只剩我一人干所有活,但不给涨薪!想主动换工作,又想要赔偿,该怎么办?...

很多时候&#xff0c;工作就像鸡肋&#xff0c;食之无味&#xff0c;弃之可惜。 一位网友求助&#xff1a; 37岁&#xff0c;在如今公司工作4年。公司今年裁员&#xff0c;部门设计组从5人缩减到1人&#xff0c;只剩他自己。侧面了解到公司并没有裁他的打算。现在他心情很复杂&…

职场新人如何使用ChatGPT提高工作效率

刚刚从象牙塔中毕业&#xff0c;走向社会战场。作为职场新人的同学们刚刚进入公司和部门&#xff0c;难免会被安排做些本职工作之外的事务工作&#xff0c;被上级安排做些零零碎碎的小东西&#xff0c;俗称打杂。这些工作说难不难&#xff0c;想要做漂亮也并不简单&#xff0c;…

ChatGPT 最佳实践指南

GPT Best Practices GPT 最佳实践指南 This guide shares strategies and tactics for getting better results from GPTs. The methods described here can sometimes be deployed in combination for greater effect. We encourage experimentation to find the methods that…

基于 ChatGPT 和 React 搭建 JSON 转 TS 的 Web 应用

在本文中&#xff0c;你将学习如何使用 ChatGPT API 构建一个将 JSON 对象转换为 Typescript interface 的 Web 应用 为什么你需要它&#xff1f; 许多网站为不同的场景提供 API 简单的解决方案是发送 JSON 并返回 Typescript 中的interface 你也可以使用 JSON-to-typescri…

ChatGPT 能为计算材料科学做些什么?未来会取代计算材料科学家吗?

来源&#xff1a;ScienceAI 本文约2600字&#xff0c;建议阅读5分钟本文简要讨论了 ChatGPT 可能应用于计算材料科学的 3 个方面&#xff0c;即生成结构、计算材料软件编程&#xff0c;数据可视化等。 ChatGPT 已火爆全球&#xff0c;它可以完成一系列具有挑战性的任务&#xf…

强到在IQ测试中“碾压”人类的ChatGPT,可能解不出这几个数学脑筋急转弯

来源&#xff1a;AI前线 作者&#xff1a;Meghan Bartels 译者&#xff1a;王强 策划&#xff1a;刘燕 ChatGPT 可以在 IQ 测试中拿到高分&#xff0c;但它没法在传奇数学谜题大师 Martin Gardner 设计的题目中击败人类高手 事实证明&#xff0c;如果你想解答一个脑筋急转弯问…

我们拆了一款将ChatGPT“落地”的AI语音交互机器人,八核A7全志R58主控

视频版本拆机&#xff1a;【60块钱&#xff0c;垃圾佬的第一台机器人&#xff0c;国产8核CPU全志R58】 https://www.bilibili.com/video/BV1Qk4y177ja/?share_sourcecopy_web&vd_source6ec797f0de1d275e996fb7de54dea06b 公子小白是一对由狗尾草智能科技推出的人工智能机…

万字长文:Stable Diffusion 保姆级教程

万字长文&#xff1a;Stable Diffusion 保姆级教程 2022年绝对是人工智能爆发的元年&#xff0c;前有 stability.ai 开源 Stable Diffusion 模型&#xff0c;后有 Open AI 发布 ChatGPT&#xff0c;二者都是里程碑式的节点事件&#xff0c;其重要性不亚于当年苹果发布iPhone&a…

Claude注册保姆级教程,含添加slack失败等问题处理方式

ChatGPT最强平替Claude 1. 搜索claude官网 网址&#xff1a;https://www.anthropic.com/product2、添加到slack 进入官网后下拉&#xff0c;滚动到页面底部&#xff0c;点击Product News&#xff0c;“Claude in Slack”。3、进入slack应用市场 https://w1685857018-gkt521992…

外汇天眼:Apple与MetaQuotes之争!谁是下一个Apple?谁会成下一个MT4/5?

手机巨头Apple 从其应用商店App Store中下架领先的交易软件MetaTrader4&#xff08;MT4&#xff09;和 MetaTrader5&#xff08;MT5&#xff09;引发了外汇市场热议。 虽然截止发稿&#xff0c;Apple以及交易软件MT4/5供应商MetaQuotes均未对此次事件发表任何评论&#xff0c;…

yfinance 国内使用,下载雅虎财经数据

本文基于2021年发布的FinRL框架&#xff0c;在第一步下载数据便遇到了问题 要么时区获取不到&#xff1a;No timezone found, symbol may be delisted 要么数据没有&#xff1a;No data found for this date range, symbol may be delisted 其实都是代理问题 FinRL: Deep Re…

ChatGPT想干掉测试人员,做梦去吧

很多人都发现ChatGPT可以做一些代码相关的工作&#xff0c;不仅可以写一些测试用例和自动化脚本&#xff0c;还可以做一定量的调优&#xff0c;于是就开始担忧起来&#xff0c;到哪天我的测试工作会不会被ChatGPT这个工具给取代了&#xff1f; 1. ChatGPT目前对哪些东西会有冲…

《Steam平台上的VR虚拟现实》(Yanlz+Unity+XR+VR+AR+MR+Steam+SteamVR+Vive+Oculus+Valve+立钻哥哥+==)

《Steam平台上的VR虚拟现实》 《Steam平台上的VR虚拟现实》 版本 作者 参与者 完成日期 备注 YanlzVR_Steam_V01_1.0 严立钻 2019.04.01 ##《Steam平台上的VR虚拟现实》发布说明&#xff1a; “Steam平台上的VR虚拟现实”&#xff1a;是对“Ste…

HTC VIVE VR眼镜的介绍以及初始化设置

硬件设备介绍 使用的硬件设备&#xff1a;HTC VIVE 或 HTC VIVE Pro 1.认识一下HTC VIVE VR头盔上的主要部件&#xff1a; A 是基站(定位器) x 2(发射激光定位头显与手柄控制器) B 是同步线 C 是基站电源适配器 x2(任何电子设备都需要能源支持) E 是联接器(把头显和电脑连起…

2018VR排行手机VR眼镜哪个好?VR眼镜多少钱,哪个VR眼镜性价比高?评测推荐

摘要:虚拟现实(VR)头戴设备目前已成为市面一类比较火热的产品,它有哪些分类呢?一般可分为头戴类、非头戴类和手套类。怎样选购vr眼镜?不妨先来看看目前比较火的vr眼镜产品评测。

Type-C接口AR/VR眼镜转接器方案,同时支持边传输数据边充电

近几年&#xff0c;人们对电子数码设备的需求也不断提升&#xff0c;VR眼镜作为终端显示产品也不断更新迭代。目前VR眼镜开始配备USB -C接口&#xff0c;现在苹果、华为、三星、华硕、小米等品牌的笔记本都支持通过USB C接口来进行视频数据传输。 USB-C接口除了能够用来传输文…

在你眨眼时,VR这样欺骗你的视觉

VR的沉浸感&#xff0c;可以让人仿佛置身于现实之外&#xff0c;还可以利用各种生物传感特性&#xff0c;来模拟一种具有存在感的虚拟空间。实际上&#xff0c;VR可以很好的欺骗人的感官&#xff0c;比如尽管你身处空间有限的房间中&#xff0c;但在VR中你仿佛已来到开阔的户外…

VR眼镜转接器方案,支持同时给电脑手机设备及VR供电。

近几年&#xff0c;人们对电子数码设备的需求也不断提升&#xff0c;VR眼镜作为终端显示产品也不断更新迭代。目前VR眼镜开始配备USB -C接口&#xff0c;现在苹果、华为、三星、华硕、小米等品牌的笔记本都支持通过USB C接口来进行音视频数据传输。 USB-C接口除了能够用来传输…

【2018VR眼镜评测】UGP VR和千幻魔镜哪个好?暴风魔镜和小宅VR有什么区别?哪个牌子VR眼镜好?2017

按照目前VR的硬件形态来划分&#xff0c;VR头戴设备主要分为三种&#xff1a; 1、移动端头显(又叫手机VR) 2、一体机VR 3、PC端VR 【三种VR的的区别】 移动端VR&#xff1a;其实这类产品又称为VR盒子&#xff0c;方便小巧且便宜&#xff0c;相当于纸盒vr的进阶&#xff0c;价格…