社区
研发管理
帖子详情
如何写给用户看的文档
phm
2003-01-02 05:25:42
如何写给用户看的文档
...全文
108
20
打赏
收藏
如何写给用户看的文档
如何写给用户看的文档
复制链接
扫一扫
分享
转发到动态
举报
写回复
配置赞助广告
用AI写文章
20 条
回复
切换为时间正序
请发表友善的回复…
发表回复
打赏红包
cuicui
2003-01-08
打赏
举报
回复
兄弟的经验就是,详细,起初我们假设用户是不会用计算机的菜鸟,后来实践证明我们的假设错了,现在我们假设用户是能看懂中国字的猩猩!
quan30
2003-01-08
打赏
举报
回复
FS+UI
也就是功能列表+用户界面.
也算是一个不错的方法吧.
图形的东西,用户肯定能看懂.
czyf2001
2003-01-08
打赏
举报
回复
我想知道如何写详细设计规格说明书?
是不是要有???
phm
2003-01-03
打赏
举报
回复
需求阶段和用户交流需求的文档
USE-CASE来表示
怎么个表示方法.....
例子....
windcsn
2003-01-03
打赏
举报
回复
不知道楼主现在在什么阶段要写给用户的文档?
1,如果是需求阶段和用户交流需求的文档,可以用USE-CASE来表示,主要是用来和用户交流他们的需求和你的理解,这个时候尽量多用一些用户能懂的方式来表达你的意思,如果用户发现你的理解没有符合他们的需求,他会和你更改需求,这样才能让用户的需求在最早阶段让我们知道。
2。如果是开发以后的用户文档,我想无非是使用说明:也就是功能方面的说明,这个简单,只要将系统的功能表达清楚即可,但是要按照需求来,以免客户发现你没有完成他的需求;还有就是你设计思路的表达,这个比较难些,主要是留给项目做存档用的文档。
我也在学习!
webcat
2003-01-03
打赏
举报
回复
如果用use case一定注意用户是否理解你的建模方法
webcat
2003-01-03
打赏
举报
回复
用用户看的懂的语言及建模方法描述功能及业务流程
ozzzzzz
2003-01-03
打赏
举报
回复
use case 不是用例图
它是一种格式化文档 use case图是use case的一个图示 并不能完全代表use case的所有内涵
Lin_Zhoubo
2003-01-03
打赏
举报
回复
既然是写给用户看的文档,那就要站在用户的角度来写,尽量的大众化,
如出现技术性的术语,就来个附录,在附录中给技术性的术语加注释.
Tryway
2003-01-03
打赏
举报
回复
公司在终极目标就是服务于用户,因为他们才是企业的上帝。
所以一定要简明易懂。
czyf2001
2003-01-02
打赏
举报
回复
use case:
用例图:是用来进行建模用的:
在很多的UML语言书籍中你会找到!
haitaoyu
2003-01-02
打赏
举报
回复
给用户看的文档?除了需求文档,还有操作手册、使用说明等,你只要遵循“用用户的眼光看系统”的原则就行了
stonespace
2003-01-02
打赏
举报
回复
use case是描述功能需求的一种格式,详细可以参考《UML与模式应用--面向对象分析设计导论》。
如果你要描述清楚需求,也可以用crc card。
不论用什么格式,描述需求应该让用户明白你要做什么功能,然后写的东西越少越好,因为看文档是一件让人头疼的事情。另外描述要准确,如果你写的东西用户理解成其他东西,到交付的时候你就惨了,用use case可以最大限度避免这类问题。
另外,尽量不要用你的专业术语,尽量用用户的领域术语,不过你要先弄清楚用户领域术语的精确含义。
bilbo0214
2003-01-02
打赏
举报
回复
说的不好听一些
你可以把用户当成傻瓜
给傻瓜说清楚一个问题当然要花一定的时间和口舌了
哈哈,
玩笑而已
bilbo0214
2003-01-02
打赏
举报
回复
软件流程图就别写了,
技术人员都要看很长时间
何况不懂技术的用户,一看就烦
bilbo0214
2003-01-02
打赏
举报
回复
尽量少用技术术语,即使用也一定要解释清楚
文字当然要让别人看懂
phm
2003-01-02
打赏
举报
回复
写给用户要多少呀
要把他们要做的功能写出来
还有什么,流程图写吗
phm
2003-01-02
打赏
举报
回复
use case
是什么呀
用什么格式
termite
2003-01-02
打赏
举报
回复
good!
stonespace
2003-01-02
打赏
举报
回复
首先要弄清楚用户关心什么,用户想看什么就写什么内容,用户不关心的不写。
然后弄清楚用户的水平怎么样,用户看不懂的东西也不要写。
需求分析文档可以用use case格式来写,然后再补充一些需求。不要假设用户看不懂use case。
....
软件开发计划书(是 一个完整的项目开发
文档
)
软件开发计划书 ..............1.任务申请.doc ..............2.可行性与计划阶段--可行性研究报告.doc ..............2.可行性与计划阶段--项目开发计划.doc ..............3.需求分析阶段--数据要求说明书.doc ..............3.需求分析阶段--
用户
手册概要.doc ..............3.需求分析阶段--需求说明书.doc ..............4.概要设计阶段--数据库设计说明书.doc ..............4.概要设计阶段--概要设计说明书的.doc ..............4.概要设计阶段--组装测试计划.doc ..............5.详细设计阶段--详细设计说明书.doc ..............6.实现阶段--模块开发说明.doc ..............7.单元测试阶段--单元测试报告.doc
接口
文档
如何写
前言: 最近看了很多写的非常好的接口
文档
,在理解业务方面给了非常多的帮助,解决很多时候对于一些协商数据的问题困扰,同时,后续个人的工作当中,也需要对外开放接口给第三方进行调用,这时候一个好的规范
文档
可以解决很多问题。 文章目的: 个人对于写接口
文档
的一些资料整理。 学习如何写一份别人乐意去看的
文档
。 希望可以通过本文帮助处理那些面临自己写接口
文档
的情况下无从下手的尴尬的局面。 目录: 主要分为以下两个版本,两个版本各有各自的特点,需要应对不同的应用场景 简单版本 复杂版本 简单版本 核心:
JFinal从入门到实战视频教程【60集】
本套课程内容是基于 JFinal4.8/4.9 官方
文档
+实战经验精心整理而成,核心内容为 JFinal 官网
文档
,但绝不是直白的
文档
翻译,中间加入大量的归纳总结、代码演示,并向外延伸了不少知识点。 整套课程共计60节课,时长约1134分钟,分为三个部分。第一部分是快速上手,使用 JFinal 推荐 Undertow 开发方式完成第一个JavaWeb项目创建,直观的体验下JFinal的极速开发;第二部分是核心知识,详细介绍JFinal的配置类、Controller、AOP、Enjoy引擎、数据库操作、插件等相关知识点;第三部分是项目实战,从无到有的写一个完整的
用户
管理功能,串联核心知识点,并借着这个项目分享一些实际开发中使用的前端框架和插件。
项目
文档
怎么写
项目
文档
怎么写 1. 怎么写项目开发的
文档
软件开发中
文档
的编写是一个不可缺少的环节,常见的如《需求分析》、《概要分析》、《数据库设计》等。在“软件人”的阵营里向来存在两种观点,注重
文档
还是关心代码。 我这里写一个《
用户
信息模块的概要设计
文档
》,只列举主要内容了 1.功能描述:用于完成系统
用户
信息的新增、删除、修改、查询; 2.功能用例:一个主用例
用户
信息,附加新增、删除、修改、查询4个子用例,操作人员为管理员,图形就不画了,很简单的; 3.业务流程:查询有效范围
用户
信息——》新增
用户
信息——》判断当前帐号
一步一步教你如何写开发
文档
App开发过程中的
文档
分为很多种,比如最常见的就是官方的开发
文档
,这种比较倾向代码和接口,但是你可能还见过或者听过其他
文档
。比如,这里根据个人理解整理了几个。开发
文档
需求(原型)
文档
需求(说明)
文档
技术方案
文档
Bug修复
文档
注释
文档
代码与UI规范
文档
性能优化
文档
是不是有点晕了,哪有这么多鬼,其实按照之前的习惯,我都是一份开发
文档
就够了,基本上包含上面的东西,只是看你怎么细分。实际开发中如果真的遇到要写上面开发
文档
可以从下面几个角度写。一. 开发环境及工具。
研发管理
1,265
社区成员
28,324
社区内容
发帖
与我相关
我的任务
研发管理
软件工程/管理 管理版
复制链接
扫一扫
分享
社区描述
软件工程/管理 管理版
社区管理员
加入社区
获取链接或二维码
近7日
近30日
至今
加载中
查看更多榜单
社区公告
暂无公告
试试用AI创作助手写篇文章吧
+ 用AI写文章