Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
D
doc
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
liupengfei
doc
Commits
1aa66a36
Commit
1aa66a36
authored
Jun 18, 2020
by
liupengfei
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add README.md
parents
Pipeline
#264151
failed with stages
in 0 seconds
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
91 additions
and
0 deletions
+91
-0
README.md
README.md
+91
-0
No files found.
README.md
0 → 100644
View file @
1aa66a36
# 创新活动项目文档
# 背景
1.
需求背景(立项的时间点 和重大变更的时间点)
2.
活动玩法描述
3.
主要方向 (主要是针对,活动的宗旨,当产品提出不符合定位方向的问题时候,轻度参与者也可以提出质疑)
# 名词解析
本项目,包括本项目相关的名词解释。如果涉及到大盘或者通用的解析可以引用。但是尽量补全。
# 版本变更
只写主要在用的代码(表格说明)
如:
1.
基础版本 基本所在分支
2.
其他版本, 其他版本比基础版本多的功能, 其他版本所在分支(如果有的话)。
# 项目介绍
图文讲解,当前项目主要的玩法, 区分页面和模块,只从功能讲解, 当前页面或者当前模块主要是做什么的。
# 开发
1.
开发流程
从接到常规需求时, 你想对一个新人说的,怎么让他通过本段文字,可以正常的建好项目文件夹(新建皮肤)或者是
在原有皮肤修改(怎么从产品文档上根据 旧皮肤 找到 项目文件中的源码)
2.
测试流程
怎么构建测试皮肤。新皮肤,老皮肤。
当新手将项目写好之后,怎么发布到管理平台上,包括配置项(可以引用,大盘的说明)
3.
发布和上线
发布和上线需要补充的。
# 映射 (重点)
选出较为基础版本的代码。
1.
目录拆分 (主要讲解 当前代码文件夹或者文件的主要指责)
2.
主流程调用栈 (流程图 或者其他方式)
*
从页面初始化 到 页面结束。
如大富翁:
游戏初始化 -> 初始化数据(xx接口)根据xx 字段确定位置 -> 组装地图(xx函数/xx模块) -> 抛出事件,初始化完成
开始游戏 -> xx,确定要走的步数 -> 提前加载步数中的异步券和弹窗 -> 走到当前步数(等待之前执行的promise的返回)-> promise释放 -> 走到下一步。
补充: 对于每一步骤 比较复杂的,可以再拆开。
开始组装地图(xx函数/xx模块) -> xx -> xxx -> xxx -> 渲染完成
*
特殊地方,要做说明,比如用到了某种特殊的方案对待兼容处理。
例如:promise弹窗释放前 可能会跳往第三方页面。目前的处理策略是立即跳转三方页面,如果用户返回(步数会直接跟上一次丢出去的塞子同步)。
*
对于模块划分还算清晰的部分,讲一下代码中,该模块的主要功能和职责。
3.
潜规则
对于后来人开发的一些告诫,比如,不希望 发生的事情。
因为项目中,架构啊,或者通用的术语啊,和大盘差别不是很大。 但是这些项目会单独立项目的原因是
要么代码量大 要么活动参与复杂,所以这个部分应该会有别于大盘。
注意: 这些不是注释,即使有注释, 在一堆代码里面找某条逻辑对于一个新手是很困难的, 而新人上手一个项目的困难点在于主要脉络不清晰,而不是某个细节问题。
所以,这部分内容希望涵盖活动大部分的内容, 重要部分也要单独拎出来 做说明。这样项目有主线,对于项目细节更好推敲。
# 黑魔法
文字或者其他方式介绍下,项目中动效的实现原理, 以及还原ui过程中,是否需要取巧 或者 人工对齐。。让别人改动的时候注意一下。或者对图片的要求等。
# 历史债
对于当前项目中,哪些模块划分的不清楚或者实现方式不好的地方作出说明。
# 未来
对历史债的规划,是否计划修改,修改要尽量做成什么样子的。
\ No newline at end of file
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment