《少数派创作手册》现已上线,欢迎与我们继续共创
2022-10-14 11:14:37 Author: sspai.com(查看原文) 阅读量:12 收藏

作者是少数派最宝贵的财富。为了服务作者,少数派一路上做出了不少努力。这既包括在功能上提供简洁实用的编辑器、个人主页和统计信息,也包括从制度上建立有竞争力的奖励机制、尽量发挥文章价值的选编流程。

但如果说我们过去有什么做得不够到位的地方,那可能就是没有将这些面向作者提供的功能、流程和资源,以更完整和统一的形式呈现出来。尽管我们此前也经常书面公布一些重要变化,但主要是以单篇文章的形式发布,未成体系;随着少数派的发展,其中很多内容也尚未及时更新。

正如优秀的软件大多都有细致的使用手册、高效的团队大多都有规范的书面沟通;对于「发文章」这个少数派最重要的「产品」,我们也意识到有必要提供一份实用和可操作的完整文档。这样,作者能够更快捷地获得创作过程中所需的信息,我们也能更一致地传达对于内容选编的标准和主张。

为此,我们花时间编纂和更新了少数派与内容创作相关的流程和规范,制作了一份《少数派创作手册》;经过一段时间的检查和测试,现在很高兴公开和大家分享。

访问《少数派创作手册》 

主要内容

《少数派创作手册》的主体由「创作指南」和「风格规范」两个部分构成。

「创作指南」部分大致按照一名新作者在少数派参与创作的流程编写,依次说明了在少数派写什么、如何获得发文资格、怎样使用文章编辑功能、怎样将文章投递到合适的板块、怎样与编辑部协作修改,以及怎样从优秀作品中获得收益等问题。

「风格规范」部分则公开了少数派编辑部在评价文章时遵循的标准,旨在回答很多用户最感兴趣的问题:什么样的文章可以被精选?什么样的文章可以上首页?对此,我们从所有内容通用的规则、以及某些性质或体裁内容适用的专门规则两个角度作出回答。

这一部分的《风格指南》一节,也是整个手册中最长的单节。内容涵盖用词和措辞、标点符号、文本样式等一般行文排版规范,并提供了工具、技巧、参数等实用参考;既是为了方便作者查阅,也反映了我们对于文章外在品质的要求。

当然,这里的「规范」和「规则」都是针对在少数派发布内容的特定场景而言的,其制定和适用过程也受限于我们的阅历和认知;我们并不主张上述范围之外的权威性,基于这些规则做出的结论也不能代表内容在少数派以外渠道的价值。

除上述主要内容之外,手册还列举了编辑部成员的职能分工、擅长内容领域等信息,方便作者按需联系。

使用方式

如手册欢迎页所述,用户可以从头按顺序完整阅读,也可以作为创作过程中的参考文件按需查阅。

使用过程中,你可以从上方导航栏选择要阅读的大分类,然后从左侧边栏选择具体的分节:

  • 当前阅读分节的细目会在该节标题下展开,并随着翻页实时高亮当前所处的小标题;
  • 如果想要返回页首,可以略微向上翻动页面,然后就能看到出现的「回到页面顶部」按钮;
  • 如果你认为某个小标题下的内容有后续查阅的价值,可以右键点击(或在触摸屏上长按)小标题右侧的段落标记(¶),复制直接跳转到该位置的链接。

页面右上角有一个简单的搜索功能,方便快速查找写作过程中名词。例如,如果你对于「社区通道」这一概念感兴趣,就可以通过搜索框找到板块划分、编辑器操作等不同篇目中提及这一概念的位置。

此外,我们也提供了明暗两种配色的主题,以及生成适合纸张版式的全文 PDF 功能,方便用户按照自己最习惯的方式阅读《少数派创作手册》。

幕后细节

《少数派创作手册》是使用 MkDocs 制作的纯静态站点,主题基于 Material for MkDocs 修改。

选择这一方案,主要是基于以下考虑:与少数派主站相比,专用的文档工具能提供更多方便撰写和阅读的功能;与商业版文档托管服务(如 GitBook)相比,对于这类并不复杂的项目,开源的静态站点生成器成本更低、自主空间更大;而与其他一些速度更快(如 Hugo)、功能和视觉效果更「酷炫」(如 Docusaurus)的生成器相比,MkDocs 能更好地兼顾我们所需范围内的版式效果、方便程度和性能表现。

值得一提的是,这一方案本身就来自于作者提供的输入。去年九月,根据早期少数派会员的反馈,我们决定提高会员内容中技术类文章的比例。在为此征集的第一批稿件中,就有一篇资深作者 100gle 贡献的《MkDocs 快速上手指南》。经历了沟通和改稿过程,尽管当时并没有直接的使用场景,我们也对于 MkDocs 的适用面和功能建立了一定印象。正因如此,当为《少数派创作手册》选择框架的需求出现时,我们很快想到并测试了 MkDocs,确认它是一个合适的选择。

至于封面图片,来自比利时画家 Charles Hamilton Smith 于 1837 年左右绘制的海獭,藏于耶鲁大学英国艺术中心,已进入公有领域。

欢迎反馈

由于编写时间有限,我们目前仍将《少数派创作手册》定义为测试阶段的文档,后续将根据实际需要和反馈情况及时完善。这里,我们也欢迎所有对在少数派创作感兴趣的朋友阅读,并提供宝贵的意见和建议。

在编写过程中,我们参考了互联网上现有的大量经验和成果,这在文中大多以「参阅」的形式提及并附上链接。同时,本手册采用知识共享署名 4.0 国际许可协议分发,欢迎自由地共享或演绎,只要在此过程中包含署名、不附加额外限制;用于生成手册站点的文件和代码也公开提供,采用与上游兼容的 MIT 许可证。谨此,我们希望能够基于自身实践,对于中文数字内容的标准做出一定的贡献和主张。

© 本文著作权归作者所有,并授权少数派独家使用,未经少数派许可,不得转载使用。

少数派编辑部


文章来源: https://sspai.com/post/76154
如有侵权请联系:admin#unsafe.sh