掘金小册写作参考

掘金小册是 小篇幅
高浓度
成体系
有收益
的内容。既满足读者的学习需求、也满足作者的创作和收益需求,而个中效率的提升就依赖着掘金小册产品模式的优化。

小册主题方向

  • 小册研发的背景介绍(调研用户痛点在哪里?清晰的描述问题的来龙去脉,说明开发者解决这个问题应该具备的能力模型
  • 小册内容设计思路(如何有效解决问题?有哪些特点?)
  • 小册的主题(突出关键信息)
  • 小册大纲(逻辑条理,模块划分)
  • 适宜人群(受众画像)
  • 学员收益(授课目标)
  • 作者介绍(公司/Title,工作经验/项目经历/博客等)

注意事项

  • 小册的选题和策划思路,一定要明确:从解决问题的思路,和站在用户学习成长的角度去思考写作,目标是 找到一个痛点问题
    提供解决方案思路
    并打造一个好的教程
    ,这跟单纯的通过专栏文章分享个人学习经验或公司内部的经验有定位上的显著区别;
  • 小册作为付费产品,用户阅读体验要求更高,必须做好定位、策划和针对性优化。

几个掘金小册的推荐大纲结构

  • 一、开发实现顺序
    许多技术类内容都是要顺着具体的开发引导来的,因而按照实现的顺序一层一层、一步一步地讲解,是可以帮助读者从头到尾把内容连贯起来的。
    以《如何写一本掘金小册》为例:先讲掘金小册是什么,然后读者就会问那怎么用啊?然后就会想要写什么怎么写?然后就是要如何售卖?上线之后有了读者就会思考如何来维护和讨论?有了读者获得了内容就可能出现版权问题?最后,讲明白掘金小册的需求,就希望更多人来写,因而留下申请成为小册作者的方法。
    • 第一部分:介绍我们要做什么
    • 第二部分:按照实现顺序按部就班地详解流程
    • 第三部分:完成的结果,照应主题,留下读者可以继续深入学习、执行的方法…
  • 二、概念到细节
    很多技术内容的讲解,尤其是一些新的技术,最先要讲明白背后的概念,让读者对这个内容有了一个概括性的了解,然后再深入背后的细节完成实体的内容。
    以《Git 原理详解及实用指南》为例:Git 虽然为大家熟悉,但它本身是一个分布式版本管理工具(DVCS)及其基本的概念需要让读者先理解。然后来讲一些核心概念,如 repository、branch、stage 等等;然后讲基本操作以及最后的一些工作中会遇到的实用方法。一步步从概念走到细节。
    • 第一部分:技术的基本概念
    • 第二部分:技术的核心概念
    • 第三部分:技术的基本功能和实用方法
    • 第四部分:技术的高级实用技巧
    • 第五部分:总结 + 深入学习的资源列表…
  • 三:总分平铺
    还有一种小册的大纲结构是以经验总结、最佳实践、问题解决方案为主的平行内容。这样往往一开始先讲明白小册的核心目的和价值,然后就会围绕主题一个一个讲解决方法、或者一个个的补充内容。
    以《响应式编程 —— RxJava 高阶指南》为例:小册的目标是去帮助读者理解 ReactiveX 概念和 RxJava 的高阶问题。在第一节解释清楚 Rx 的价值之后就会围绕着 Rx 和 RxJava 逐一讲解概念和高阶问题,但是各个问题之间的关系相对是平行的。
    • 第一部分:小册要去解决的问题的重要性和核心内容
    • 第二部分:一个一个地讲解内容
    • 第三部分:总结…

开头和结尾

掘金小册的小节作者可以开放试读功能,而一般第一小节都会选择试读。因而,一本小册的第一小节往往是读者对小册的第一印象。

我们建议一个小册的开头:

  • 清楚讲解小册的核心价值和目的
  • 配以合理的介绍性的文字、图片代码,甚至是 Demo
  • 对整本小册的结构大纲有一个概述性的介绍,为后面的核心内容做铺垫和准备

读者完成一本小册的阅读,到达最后一个小节,可以获得其期待的知识信息。但是,读者往往在这一刹那希望可以获得更多、可以与作者和其他读者交流、可以有更多的资源和技术可以更深入的学习下去。

因而我们建议一个小册的结尾:

  • 回顾整本小册,对内容、核心产出、重点做一次总结
  • 援引一些资源、开源库、书籍、文章链接,让读者可以继续学习
  • 给读者以与作者继续保持联系的方法…

小册方法论

  • 题目应简洁直接、直达主题
  • 一本小册小节数一般不应该超过 15 小节
  • 小节的标题同样要简洁明了,一眼就明白小节的价值
  • 小节之间应连贯有逻辑,遵从一个大纲排布规则
  • 每一小节的平均阅读时长在 10 分钟左右
  • 每一个小节都应该在文段里有一个标题
  • 每一个小节最后最好有一个小结来总结本小节的核心内容
  • 可以根据小册的特点,适当地设置一些练习题或问答题
  • 最后一个小节应该有一个总结和延伸阅读的入口
  • 图片应该大小合宜且清晰,包含图片描述
  • 准确的代码区块,切忌大段粘贴代码
  • 内容排版中善用 h2、h3、blockquote、code、ul、ol 等元素
  • 在内容上多使用链接去援引外部内容…

参考

  • 如何写一本掘金小册
  • Git 原理详解及实用指南
  • 区块链开发入门:从 0 到 1 构建基于以太坊智能合约的 ICO DApp
  • 剖析 Vue.js 内部运行机制

原文 

https://linmi.cc/535.html

本站部分文章源于互联网,本着传播知识、有益学习和研究的目的进行的转载,为网友免费提供。如有著作权人或出版方提出异议,本站将立即删除。如果您对文章转载有任何疑问请告之我们,以便我们及时纠正。

PS:推荐一个微信公众号: askHarries 或者qq群:474807195,里面会分享一些资深架构师录制的视频录像:有Spring,MyBatis,Netty源码分析,高并发、高性能、分布式、微服务架构的原理,JVM性能优化这些成为架构师必备的知识体系。还能领取免费的学习资源,目前受益良多

转载请注明原文出处:Harries Blog™ » 掘金小册写作参考

赞 (0)
分享到:更多 ()

评论 0

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址