V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX 提问指南
magine
V2EX  ›  问与答

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

  •  
  •   magine · 2014-10-14 16:58:16 +08:00 · 3174 次点击
    这是一个创建于 3696 天前的主题,其中的信息可能已经有所发展或是发生改变。
    如题,本来是自己写了一套国有资产管理系统给自己学校用,结果其他学校看了下觉得不错说想要购买。

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

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

    附网站地址 http://magine.info/
    21 条回复    2014-10-15 08:49:58 +08:00
    pfitseng
        1
    pfitseng  
       2014-10-14 17:07:31 +08:00   ❤️ 1
    老师就是事多,毕业证拿了吗?没拿就好好写。
    1,现状 balabalabala
    2,你的系统的特点 这段一定要字多,并且保证正常人能看懂
    3,为什么要用你这个系统 用词有新意,比如“在可预见的将来,一定能极大的提高啥啥啥”
    4,来点参数或者测试来证明第3条
    5,现在部署的实际情况
    6,没了,我想不出来了
    Livid
        2
    Livid  
    MOD
       2014-10-14 17:08:22 +08:00   ❤️ 1
    - 系统主要功能的列表
    - 要完成每一个功能的操作步骤
    holystrike
        3
    holystrike  
       2014-10-14 17:12:47 +08:00   ❤️ 2
    百度文库中有类似文档的模板,以及很多现成产品的说明书,但不尽相同

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

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

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

    至于运行环境、服务器要求这些可以写,但是对普通教师和资产管理员来说就没有用
    mornlight
        4
    mornlight  
       2014-10-14 17:15:18 +08:00   ❤️ 1
    是使用说明还是什么说明。如果是使用手册之类的东西看看别人家是怎么写的就可以了。
    楼主写得一手好Django啊
    virusdefender
        5
    virusdefender  
       2014-10-14 17:30:45 +08:00   ❤️ 1
    随手点了一下管理员登陆 我就知道是Django的了
    哈哈 我也很喜欢Django
    virusdefender
        6
    virusdefender  
       2014-10-14 17:47:19 +08:00
    @holystrike 额 我是想点回复的,,我想说咱两个头像一样。。
    chairuosen
        7
    chairuosen  
       2014-10-14 17:49:02 +08:00   ❤️ 1
    把代码的注释都copy出来,233333
    lingyired
        8
    lingyired  
       2014-10-14 18:19:54 +08:00
    @virusdefender 不一样
    magine
        9
    magine  
    OP
       2014-10-14 18:39:17 +08:00
    @mornlight
    是我和别人合作开发的,我只负责后台,和最初的页面设计。
    Django的话看看我的提问记录就知道我是个新手啦,哈哈。
    arslion
        10
    arslion  
       2014-10-14 18:46:35 +08:00
    哈哈,跪求换字体~
    justfindu
        11
    justfindu  
       2014-10-14 18:49:11 +08:00
    就是教他们怎么用 系统有哪些功能
    magine
        12
    magine  
    OP
       2014-10-14 18:59:36 +08:00
    @arslion

    omi你怎么看? @omi4399
    omi4399
        13
    omi4399  
       2014-10-14 19:31:29 +08:00
    @magine
    介绍:针对用处,相比传统管理有何优点,对硬件需求,售后,可变更和添加的模块
    使用指南:你懂得 包括导入数据,部署,备份等等
    omi4399
        14
    omi4399  
       2014-10-14 19:33:12 +08:00
    @arslion 你看到的字体是啥?
    arslion
        15
    arslion  
       2014-10-14 20:05:09 +08:00
    PP
        16
    PP  
       2014-10-14 20:15:30 +08:00
    你们老师显然是要《用户使用手册》,写份过程演示就可以了,从登录到各模块到退出,尽可能多的配上图。
    sdzbzyc
        17
    sdzbzyc  
       2014-10-14 20:16:58 +08:00 via iPhone
    楼主老乡啊
    omi4399
        18
    omi4399  
       2014-10-14 20:18:49 +08:00
    @arslion 主要面向 win ,默认微软雅黑,你这是缺失字体了。。。。
    magine
        19
    magine  
    OP
       2014-10-14 20:59:57 +08:00
    @sdzbzyc
    临沂人?
    magine
        20
    magine  
    OP
       2014-10-14 21:03:35 +08:00
    @omi4399
    备份还在写呢orz
    arslion
        21
    arslion  
       2014-10-15 08:49:58 +08:00
    @omi4399 让用户自己装字体才可以体验到网页的设计嘛, 这是不对滴, 字体文件也是资源哦
    下图截自36kr:
    链接: http://pan.baidu.com/s/1gdtJTcf 密码: pul9
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   3141 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 24ms · UTC 14:16 · PVG 22:16 · LAX 06:16 · JFK 09:16
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.