吐槽，所谓的“说明文档”一般要包含哪些内容？

[magine]

如题，本来是自己写了一套国有资产管理系统给自己学校用，结果其他学校看了下觉得不错说想要购买。

现在小组里的带头老师让我写一份《说明文档》，可是我个敲代码的根本不知道怎么写啊QAQ

所以说所谓的“说明文档”一般要包含哪些内容？运行环境？服务器配置要求？外观介绍？

附网站地址 http://magine.info/

[pfitseng]

老师就是事多，毕业证拿了吗？没拿就好好写。
1，现状 balabalabala
2，你的系统的特点 这段一定要字多，并且保证正常人能看懂
3，为什么要用你这个系统 用词有新意，比如“在可预见的将来，一定能极大的提高啥啥啥”
4，来点参数或者测试来证明第3条
5，现在部署的实际情况
6，没了，我想不出来了

[Livid]

- 系统主要功能的列表
- 要完成每一个功能的操作步骤

[holystrike]

百度文库中有类似文档的模板，以及很多现成产品的说明书，但不尽相同

文档的目的是让没有用过的人能快速的上手使用，所以要站在一个使用者的角度来思考如何编写

可以按照身份进行划分，普通教师、资产管理员、系统管理员他们的工作内容不同，针对性的编写各自的部分。

功能介绍+操作指引+截图+标记

至于运行环境、服务器要求这些可以写，但是对普通教师和资产管理员来说就没有用

[mornlight]

是使用说明还是什么说明。如果是使用手册之类的东西看看别人家是怎么写的就可以了。
楼主写得一手好Django啊

[virusdefender]

随手点了一下管理员登陆 我就知道是Django的了
哈哈 我也很喜欢Django

[virusdefender]

@holystrike 额 我是想点回复的，，我想说咱两个头像一样。。

[chairuosen]

把代码的注释都copy出来，233333

[lingyired]

@virusdefender 不一样

[magine]

@mornlight
是我和别人合作开发的，我只负责后台，和最初的页面设计。
Django的话看看我的提问记录就知道我是个新手啦，哈哈。

[arslion]

哈哈,跪求换字体~

[justfindu]

就是教他们怎么用 系统有哪些功能

[magine]

@arslion

omi你怎么看？ @omi4399

[omi4399]

@magine
介绍：针对用处，相比传统管理有何优点，对硬件需求，售后，可变更和添加的模块
使用指南：你懂得 包括导入数据，部署，备份等等

[omi4399]

@arslion 你看到的字体是啥？

[arslion]

@omi4399
链接: http://pan.baidu.com/s/1i3L0izz 密码: g20d

[PP]

你们老师显然是要《用户使用手册》，写份过程演示就可以了，从登录到各模块到退出，尽可能多的配上图。

[sdzbzyc]

楼主老乡啊

[omi4399]

@arslion 主要面向 win ，默认微软雅黑，你这是缺失字体了。。。。

[magine]

@sdzbzyc
临沂人？

[magine]

@omi4399
备份还在写呢orz

[arslion]

@omi4399 让用户自己装字体才可以体验到网页的设计嘛, 这是不对滴, 字体文件也是资源哦
下图截自36kr:
链接: http://pan.baidu.com/s/1gdtJTcf 密码: pul9