业务:CSDN写作指南

关于写作,笔者没有什么好的建议,除了多看书和多写之外好像也没有什么其他办法,但是对于写作的好处确实很多,笔者是做技术出身的,很多新项目的研究,系统的配置,常用功能,涉及到的技术知识很多,而且很多时候配置步骤有复杂繁琐,可能今天遇到这个问题费了九牛二虎之力解决了,过个十天半个月再遇到就又要从头开始分析问题、研究和解决,相当于又重新把之前解决的问题复现了一遍,这样的效率是很低的。后来笔者也想过很多方法,写成技术手册或者整理成知识文档,但是随着积累的东西越来越多,一旦换工作或者是换个项目,很多东西又不好整理,陆陆续续的之前总结的文档又都丢失了,最后笔者痛定思痛,决定在CSDN上开个技术博客,把日常的技术、所思所想所为都以博客的方式记录在网上,下次需要的时候可以在CSDN方便的查阅到,同时也可以把自己的经验分享出去,有些经验可能由于自己的局限性,可能存在纰漏或者不完整的地方,这样有过相同经历的读者也可以在网上纠出这些错误,共同进步,以上是笔者在CSDN上写作的初衷。接下来主要讲下写作的方法。

一、写作方法

其实我们从小就开始写作文,总-分-总,凤头猪肚豹尾等等,其实我觉得写技术文档可以不受这些形式上的约束,当然你能按照这些约束写出对读者有用的文档当然更好,但是笔者认为写技术文档的核心在阐述遇到什么问题,通过什么方法,最后解决了问题的过程。技术文档的目的就是当读者朋友看到这边文章能快速上手解决自己遇到的问题,其他的文采还是其次,最关键是清晰、准确、易懂,否则就失去技术文档本身的价值。

二、写作框架

1.overview

1.overview(概览)
1.1 who is using?(用户)
1.2 use cases(场景)
1.3 real-life example(技术性实例)
1.4 architecture(架构)
2.glossary(词汇表,关于一些概念的说明)
3.user story(用户故事)

2.Installation and upgrades

1.installation process(各种场景下的使用说明)
2.database upgrade(数据更新)

3.Quick start

1.install step by step
2.integrated into the scene(集成到使用场景)

4.Command Line Interface(常用命令,常用使用方法)

1.category:db
2.category:deployment

5.Task Component(任务组件:对输出结果的说明和验证)

1.HTML Reports
2.CLI References

6.Plugins(插件:补充和扩展)

1.plugins work(原理)
2.how to create a plugin(针对扩展实例)

7.Contribute to(加入或者联系方式)

1.where to begin
2.how to contribute

8.Request New Features(新的演进,发展方向)

9.project info(项目信息,关于人和事的说明)

1.Maintainers
2.Userful links(引用说明)
3.discuss and propose changes(Q&A)

10.Release Notes

1.All release notes(发布申明)

参考文献
1.Markdown 数学公式以及符号整理
2.金字塔原理
3.反对党八股
4.不知道写什么,怎么找选题?

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

夏老师讲数

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值