the5fire的技术博客

关注Python、Django、Vim、Linux、Web开发、团队管理和互联网--Life is short, we need Python.


写书备忘一

作者:the5fire | 标签:     | 发布:2018-06-19 9:41 p.m. | 阅读量: 565, 529

写书备忘一

端午节本来是打算休息下,然后开始准备Django源码分析视频的大纲,结果计划赶不上变化,出版社的编辑老师给我提了一些修改建议,于是端午节都在改书稿。

简单备忘一下,万一其他人需要写书可以参考下,或许能节省不少时间。

因为不知道后续还有没有需要改的地方,所以这个是“一”。

写书建议

  • 开写之前整理出大纲,至少要到三级目录也就是下面那样,好处是帮你梳理好框架,写的时候会比较方便,后面的内容在写到时肯定会调整,但是如果不岸把详细的架子定出来,后面会很累。写前面的部分很兴奋,写到后面很焦虑。(时间是不是不够了;哎,编辑老师会不会明天开始催稿;哎,又要拖稿了;哎,又拖;)

```

第一章 xxxx

    第一节 xxx

        1.1.1 小标题

        1.1.2 小标题

```

  • 代码和内容最好同步进行,没完成一章自己review下代码,要不最后得挨个打patch。
  • 用词需要谨慎,英文比如:MySQL,SQLite,不能太随便写成mysql,sqlite。
  • 程序及版本的写法需要跟官网统一,比如Python 3.6 ,不能写成Python3.6。其他也是一样。
  • 图片和表格需要编号,增加说明。标号根据章来,第一章的第一个图:图1-1。(突然想到有个表没有加编号和标注 !-.-
  • 章节序号需要加,三级标题下面的小节(也就是上面的1.1.1 小标题下的)需要从1开始编号。
  • 参考,每章节的内容如果有参考最好把参考资料整理出来,方便自己review是检测内容是否有效,也有助于读者扩展阅读。

大概就这么多,其实都是图灵的王军花老师告诉我的(最后一条是我加的),感谢。

估计后面还有调整的需求,错别字应该还有,虽然我筛了一遍了。

- from the5fire.com
----EOF-----

微信公众号:Python程序员杂谈



其他分类: