如何写作品的介绍文档

您所在的位置:网站首页 自己的作品简介 如何写作品的介绍文档

如何写作品的介绍文档

2023-09-07 14:36| 来源: 网络整理| 查看: 265

介绍文档有什么用?

让看你作品的人通过这个文档更好地了解你的作品!

以自己的一次参赛经验来分析(微信小程序应用开发大赛),总结主要是以下几个步骤:

1. 产品定位

(1)应该说清楚这是一个什么小程序,具体的应用场景是什么以及解决什么实际问题?建议直接了当,突出重点,应用场景和实际问题要有一定的调查材料支撑,注意不能是网上随便抄来的。这部分是让评委大概了解这个小程序是干什么用的以及为什么要开发。 (2)提出现实问题之后,建议简单地阐述一下自己的产品方案,这里的方案不是技术方案,而是自己打算做一个什么样的产品来解决现实的问题。

2.需求分析

虽然参赛的介绍文档中没有明确说明要做需求分析,但是产品定位的评分中要求有明确的目标用户和使用场景,所以比较好的做法是进行用户和需求分析。

(1)在用户和需求分析方面,大家可以采用自己学过的一些方法和技术,原则就是用户分析到位, 系统需求应该包括功能需求和非功能需求,不论是哪方面的需求,都应该是紧密结合自己要开发的系统,而不是泛泛地抄一些类似教科书上面的内容。 (2)举例:参观清华的非功能需求就是根据系统的实际要求,提出了关键的三个内容:一是性能, 给出具体的量化指标;二是安全性,诸如身份证敏感信息等;三是可靠性,包括停电和断网问题、游客快速进入的问题等。

3.交互设计

交互设计部分应展现整个系统的信息结构,说明配色和整体设计原则,把系统核心功能的交互设计图展现出来,然后选择自己认为可以突出亮点的几个关键设计进行说明。

4.技术方案

技术方案部分应给出系统的总体框架设计图,并做相应的说明,然后给出系统的技术选型、开发环境,包括所采用的框架、第三方组件等。总体框架介绍清楚之后,应该着重介绍系统开发方面自己的突出贡献部分或者亮点部分,这个需要根据自己开发的系统进行归纳,选择核心重点或技术难点部分来说明相应的技术实现。

5.系统测试

这个部分是可选的,为了说明自己系统的最终效果,可以考虑写一下功能测试和性能测试,说明测试方案和测试结果,要注意清楚而且有实际的真实测试结果,不要乱写乱编。 如果自己开发的系统非常简单,而且没有特别的性能要求,可以忽略这部分。

6.系统上线与运维

对于一些需要自己运营的作品,这部分也是非常重要的,需要说明如何上线以及未来的运营和维护方案,特别是一些需要特殊资质的作品,更要说清楚这一点。



【本文地址】


今日新闻


推荐新闻


CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3