网站建设与维护 许宝良 课件,流量比对网站,wordpress拉黑用户,网站开发免费作者简介#xff1a;
本文作者拥有区块链创新专利30#xff0c;是元宇宙标准化工作组成员、香港web3标准工作组成员#xff0c;参与编写《数据资产确权与交易安全评价标准》、《链接元宇宙#xff1a;应用与实践》、《香港Web3.0标准化白皮书》等标准#xff0c;下面提供…作者简介
本文作者拥有区块链创新专利30是元宇宙标准化工作组成员、香港web3标准工作组成员参与编写《数据资产确权与交易安全评价标准》、《链接元宇宙应用与实践》、《香港Web3.0标准化白皮书》等标准下面提供一些编写文档过程的而一些思考。 优质技术文档的要素
读者场景准确匹配
读者定位了解你的目标读者根据读者的特征选择合适的语言和详细程度来解释技术概念。
场景定位场景不同要求不同材料的表达方式与粒度也不同
背景概念清晰
文档中需要对文章的背景做介绍文章用到的专业术语需要加以说明
结构清晰突出重点
结构清晰在写作之前制定一个清晰的大纲。确保你的技术材料有逻辑性和结构性
突出重点使用加粗、斜体或其他方式使重要的概念或术语更加明显以便读者能够快速捕捉到关键信息
可视化可读性
可视化使用图表、图像和其他视觉元素来增强可视化效
可读性使用段落、标题和子标题来组织内容确保技术材料具有良好的可读性。行文流程、简介明了
信息正确与准确
技术类文章对技术原理描述需要准确对一些采用的数据需要说明来源并保证正确性不能夸大效果天马行空
读者定位与场景定位
读者定位根据读者的特征选择合适的语言和详细程度来解释技术概念 场景定位场景不同要求不同以下场景举例、要求也不同场景举例
1、内部的技术文档按照部门的规范与要求来写主要在部门内部流转
2、政府的项目汇报文档以政府的八股文为主有固定的句式
3、专利交底书是给代理人(非技术人员)写主要用于查重与写专利稿件。
背景介绍与名词解释
背景介绍要考虑到技术应用的上下文环境这个要交待清楚
名称解释特定名词的使用要引出简要的注释名词解释一般放在文章的前面 结构清晰
结构清晰的方法思维结构化在思考问题与梳理知识的时候做到结构化然后写文章结构先行、
然后根据结构来检查内容内容服务于结构。下面列了一些常见的编写方法 运用小标题
1、体现文章结构让读者对文章一目了然。
2、让读者快速定位想要的内容提高阅读效率 突出重点的方法
突出重点有以下常见的方法结构设计、放大颜色突出、适当留白、使用加粗或者斜体 用图表来可视化表达
可视化的好处帮忙读者快速理解技术点帮助记忆科学依据人脑对图片信息的接收程度要远大于文字 优秀文档案例
名字内容优点链接STARKEXStarkEx 利用 STARK 技术为DeFi 和游戏提供可扩展、自我托管的交易解决方案结构清晰、图表丰富、讲解详细、排版合理Introduction :: StarkEx DocumentationFISCO BCOS国内知名的开源联盟链内容覆盖全、结构清晰、排版舒适https://fisco-bcos- documentation.readthedocs.io zh CN/latest/CHAIN LINKweb3预言机系统技术原理清晰、操作手册详尽Chainlink Data Feeds | Chainlink Documentation
总结
写文章的好处
写文章是一个逼迫自己深入理解问题、把问题想清楚整理好思路并能清晰表达出来的过程。其本质是一种自我学习、自我提升、构建知识体系的最佳方法。
如何提高的写材料能力
1、刻意练习设置目标持续练习写材料
2、迭代优化文章也需要进行重构不断迭代
3、阅读与学习优秀的技术文章
