用MFC做了个手机程序,要求写文档,这个文档是用啥格式,写什么?SOS!!!
1个回答
展开全部
格式可以自定,主要是把问题说清楚
其实文档最重要的不是格式,而是传达给文档阅读者需要的信息
一般文档分为2种,给开发者的和给用户的
就你这个程序而已,需要写的东西我认为有以下东西:
(如果你的文档是给开发者或者二次开发者的)
1.程序简介,告诉读者这个程序是干什么的
2.画面介绍(如果有画面的话),介绍各个画面的大致功能以及各个画面之间的跳转关系
3.代码中使用到的框架,一些核心的数据结构,一些函数的使用说明(比如输入输出参数的含义,格式等等)
4.一些注意事项,这一条各个程序不一样,可以有可以没有,对你这个程序,可以在这里写上你程序对应的手机机种之类的信息
(如果你的文档是给最终的程序用户的,这里尽量不要使用程序员的专业术语)
1.程序简介,告诉读者这个程序是干什么的
2.画面介绍(如果有画面的话),介绍各个画面的大致功能
3.用户使用说明,各个画面的操作(比如手机程序一般都对应着键盘热键,比如上下左右各个键在本程序里面各有什么功能,以及怎么结束本程序之类的)
4.一些注意事项,各程序不一样,可有可无,对你这个程序,可以写上对应机种,安装时可能遇到的问题以及解决方案,如果你的程序需要用到网络,你可以写上运行本程序时手机必须联网之类的要求
注意,不管写给谁看的文档,上面提到的两个第3点都是最重要的
其实文档最重要的不是格式,而是传达给文档阅读者需要的信息
一般文档分为2种,给开发者的和给用户的
就你这个程序而已,需要写的东西我认为有以下东西:
(如果你的文档是给开发者或者二次开发者的)
1.程序简介,告诉读者这个程序是干什么的
2.画面介绍(如果有画面的话),介绍各个画面的大致功能以及各个画面之间的跳转关系
3.代码中使用到的框架,一些核心的数据结构,一些函数的使用说明(比如输入输出参数的含义,格式等等)
4.一些注意事项,这一条各个程序不一样,可以有可以没有,对你这个程序,可以在这里写上你程序对应的手机机种之类的信息
(如果你的文档是给最终的程序用户的,这里尽量不要使用程序员的专业术语)
1.程序简介,告诉读者这个程序是干什么的
2.画面介绍(如果有画面的话),介绍各个画面的大致功能
3.用户使用说明,各个画面的操作(比如手机程序一般都对应着键盘热键,比如上下左右各个键在本程序里面各有什么功能,以及怎么结束本程序之类的)
4.一些注意事项,各程序不一样,可有可无,对你这个程序,可以写上对应机种,安装时可能遇到的问题以及解决方案,如果你的程序需要用到网络,你可以写上运行本程序时手机必须联网之类的要求
注意,不管写给谁看的文档,上面提到的两个第3点都是最重要的
推荐律师服务:
若未解决您的问题,请您详细描述您的问题,通过百度律临进行免费专业咨询