# HELP OURSELVES

# 主要要求

非必要要求

# 方向要求

  • 主要方向是:包含但不限于计算机和数学

# 提交的文档类型要求

提交的文档类型最终会被 pandoc (opens new window) (或者 sphinx)转化为 pdf、markdown或者html等前端可嵌入格式。优先使用以下格式

  • pdf
  • markdown
  • reStructuredText
  • tex

# 提交要求

  • 可以提交到QQ群(561043735) 或者直接在 github 上 pull

# 次要要求

非必要要求

# 书写流程要求

  • 不应该直接写
  • 应该先准备材料,然后写草稿,然后再写 tex 或者 markdown 等

# 内容整体要求

  • 不应该写成论文的形式(不够连贯),更不可以是博客形式的。
  • 应该保持文章前后知识点的连贯性

# 内容具体要求

  • 不应该写太多的引例(因为读者是不会详细研究你的例子的,那是在浪费时间)
  • 应该保持引例的简单明了

# 计算机方向的要求

  • 不应该写某种程序工具的说明文档/使用手册
  • 应该详述某种程序工具的设计原理和复杂点

# 数学方向的要求

  • 不应该罗列公式/模型
  • 应该详述公式/模型

# 算法包方向的要求

  • 不应该只写某个算法包的说明文档/使用手册(比如 pyMC)
  • 应该详述某个算法包的算法原理、实现以及说明文档