《社区文档撰写指南》 | learnku 产品论坛-凯发备用官网

lk
话题列表 社区 wiki 优质外文 招聘求职 lk 实战教程 社区文档
登录
注册
社区文档撰写指南
更新于 1年前
一些撰写文档的技巧和思路，一个教你写出好文档的文档。

文档类型：系统文档

文章统计：36 篇，字数 1.63 万，点赞 245
文章列表 所有讨论

  1. 第一章. 基础信息
    1. 1.1. 创建文档
    2. 1.2. 文档系统介绍
    3. 1.3. 前缀后缀
  2. 第二章. 文档设置
    1. 2.1. 文档版本
    2. 2.2. 指定版本
    3. 2.3. 变量替换
  3. 第三章. 操作指南
    1. 3.1. 新建章节
    2. 3.2. 创建文章
    3. 3.3. 重新排序
    4. 3.4. 处理用户投稿
    5. 3.5. 批量创建章节
  4. 第四章. 使用工具
    1. 4.1. 截屏软件
    2. 4.2. gif 动图软件
  5. 第五章. 撰写规范
    1. 5.1. 排版规范
    2. 5.2. 截屏时候要释义
    3. 5.3. 截屏的尺寸
    4. 5.4. 干净的截图
    5. 5.5. 中文文案排版规范
  6. 第六章. 写作技巧
    1. 6.1. 文章开头怎么写？
    2. 6.2. 一图胜过千言万语
    3. 6.3. 控制文章长度
    4. 6.4. 代码注释和解析
    5. 6.5. 步骤清晰的文章
    6. 6.6. learnku markdown 编辑器使用指南
    7. 6.7. markdown 语法完整版
    8. 6.8. markdown 语法上手（先学这 8 种）
    9. 6.9. 插入 latex 数学公式
    10. 6.10. 贴代码时指定文件
  7. 第七章. 常见错误
    1. 7.1. 代码未遵守编码规范
    2. 7.2. 代码未使用高亮
    3. 7.3. 没有利用 gif 动图的力量
    4. 7.3. 使用外链图片
    5. 7.4. 段落标头混乱
    6. 7.5. 挤成一团的 markdown
  8. 第八章. 文档翻译
    1. 8.1. 文档翻译进化史
    2. 8.2. 生成翻译区块

关于 learnku

learnku 是终身编程者的修道场
做最专业、严肃的技术论坛
learnku 诞生的故事

资源推荐

  • 《社区使用指南》
  • 《文档撰写指南》
  • 《learnku 社区规范》
  • 《提问的智慧》

    • 服务提供商

    其他信息

  • 成为版主
  • 所有测验
  • 联系站长（反馈建议）

    • | | 违法和不良信息举报

    由 summer 设计和编码 ❤

    请登录

    内容举报
    匿名举报，为防止滥用，仅管理员可见举报者。

    我要举报该，理由是：

    取消
    网站地图