写作的注意事项
- 文章
如果文章全篇转载,请在全文开头显著位置注明出处并链接至原文
如果文章内容过多,那么可以根据内容类型进行分篇处理(保持读者的阅读耐心)
前言
- 初衷
- 适合人群
- 内容结构
- 温馨提示
文章主体
文章主体一定要符合文章前言的内容结构,除此之外内容尽量符合以下一些特性:
- 图文并茂
- 思维导图
- 框架大图
- 表格分类对比
- 可视化数据分析
- 列表分类
写作风格
- 标题
文章有且仅有 1 个一级标题
标题统一采用「#」标记
标题逐级递增(例如避免在一级标题下直接新增三级标题)
标题的「#」标记和文本之间必须要有 1 个空格,否则类似掘金平台无法识别标题
标题和子标题内容避免完全一致
标题避免有标点符号 “.,;:!?。,;:!?”
标题前后应该有空行
标题避免缩进
避免出现四级标题,保持简洁
避免出现孤儿标题
不要使用加粗代替标题
如果当前标题下内容过于简洁(例如只有一个简短的段落),可以需要考虑去除标题
标题的作用除了明确主题之外,重点是快进到想阅读的部分
作者:子弈
链接:https://juejin.cn/post/6844904168600109069
来源:稀土掘金
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。
- 段落
段落之间不要产生多个连续的空白行
如果部分段落引用其他的技术文章,则需标明作者和来源链接
段落开头避免缩进 - 引用
引用标记和内容之间避免有多个空格
引用前后应该有空行
温馨提示的内容可以采用引用的呈现形式 - 分割线
可以在图片下方添加或者是结尾的段落 - 代码块
在代码块中展示 Shell 命令不需要在命令行前加「$」符号,除非同时需要打印输出信息
代码块前后应该有空行
代码块必须指定语言类型1
2
3window.addEventListener('load', function() {
console.log('window loaded');
});
如果部分代码引用其他的技术文章,则需标明作者和来源链接
前方多图,流量预警⚠️ ⚠️ ⚠️
写作工具
思维导图 - Xmind
流程图 Gilffy Diagrams
流程图 Process On
总结
- 利弊分析
- 局限性及可扩展性
- 注意事项
- 未来发展
- 规律分析
- 横向对比
- 技术结论
- 思想指导
- 集思广益