发布指南
题目
- 避免标题党,写标题之前先确认文章的受众群体和内容对标程度,入门的内容就不要用进阶、吃透、掌握这些词等等。不要给读者一个错误的预期,最后会得不偿失;
- 简洁清楚的表达出文章主题,尽量将关键词在题目中显示出来。这样也利于 SEO 搜索优化;
- 标题的格式请参考写作指南。
内容简介
- 140 字左右的介绍即可,但一定要打磨打磨再打磨,文章的门面不要逊;
- 直击痛点,说清楚"4W1H"即可:
- who:适合谁看,讲给谁听;
- what:能给读者带来什么价值,将技术自身项目故事相结合去具体问题具体分析;
- when:内容是技术趋势?是老问题?还是未知的问题等等;
- where:跟什么场景有关;
- how:这篇文章是怎样给读者带来价值,即是原理➕实例、原理➕源码、还是实战项目等等。
- 在写文章之前最好搜索下同类主题的免费资料的内容,避免文章重合度太高。
版权意识
- 非原创的图片、流程图等等请在图片底部注明“
图片来源:xxx
”; - 文章有参考的文献请在文中标明,并在末尾的参考文献里写明出处。
个人简介
- 按照写作指南规范格式;
- 简练突出个人的项目经验和擅长方向,但不要堆积太多;
- 可以在末尾放上自己的博客、GitHub 等记录个人作品的链接地址,方便读者了解。
写作指南
标题
文章一二级标题为 ### 和 ####,三级标题为 #####xxx(加粗表示)
文本
字间距
全角中文字符与半角英文字符之间需要加一个半角空格。
例:我们每天都在GitChat上看一篇文章Chat。❌
我们每天都在 GitChat 上看一篇文章 Chat。✔️
全角中文字符与半角阿拉伯数字之间,默认加一个半角空格。
例:2019春节是2019 年 2 月 5日。❌
2019 春节是 2019 年 2 月 5 日。✔️
标点符号
全文都是全半角标点符号,但很多人会写着写着就变成半角符号。
例:今天注定是不平凡的一天,三款社交产品同时上线。❌
今天注定是不平凡的一天,三款社交产品同时上线。✔️
小短词之间用顿号。
例:Java,C,C#,C++,JavaScript,Python 等主流编程语言很受欢迎。❌
Java、C、C#、C++、JavaScript、Python 等主流编程语言很受欢迎。✔️
省略号是 6 个点,不是 3 个点这些。
例:我喜欢吃巧克力。。。❌
我喜欢吃巧克力....❌
我喜欢吃巧克力......✔️
引号
毛姆说:“阅读是一座随身携带的避难所。”
(后面没有任何标点符号)
毛姆说过“阅读是一座随身携带的避难所”。
“阅读是一座随身携带的避难所”是毛姆的名言。
“阅读是一座随身携带的避难所。”毛姆说。
书名号连用
《XX 职业要消失了》《XXX 岗位将被人工智能取代》
(连用两个书名号,中间不加任何符号,例如,不要顿号和逗号)
项目符号内容的标点符号
叙述结尾冒号
(:)
,接下来紧跟的几项末尾应该为;
最后一个为句号。
但是这里有两种特殊情况,一是特别短的项目内容,比如几个字的小短句,这种末尾可以不加; 另外一种内容特别多,里面甚至出现好几句,这种上面叙述结尾就不要加冒号了,尽量改成句号的描述方式。因为冒号后面套多个句号是不规范的。
书名号
英文书名、电影名、歌曲名、游戏名 斜体
中文书名、电影名、歌曲名、游戏名 加书名号
例:The Definitive Guide to Java Performance ✔️
《Java 性能权威指南》✔️
当文中给出的一些图书、电影、游戏等的英文名,如果其中的图书、电影、游戏已经有中文版,那我们应该提到中文版,加个括号标注。
例:高德纳的《计算机程序设计艺术》(The Art of Computer Programming)是计算机领域的不朽名著。
高德纳的 The Art of Computer Programming(中文版《计算机程序设计艺术》)是计算机领域的不朽名著。
注意事项
的地得
形容词 + 名词 用 的 例子:美丽的姑娘
动词 + 修饰副词 用 得 例子:跑得快
副词 + 动词用 地 例子:爽快地答应
名称规范
很多编名称需要注意官方规范写法,在这里先列出一些易出错的名称:
GitChat、Java、GitHub、Node.js、Python、C/C++、MySQL、SQL......