议事记录
议事流程图
议事规则要解决的问题
这个文档主要用于记录和管理项目开发过程中的各种问题及其解决方案。通过详细的记录和流程管理,它可以解决以下几类问题:
- 问题跟踪和管理:
- 记录问题: 每个问题都有唯一的编号、描述、提出人、附议人、未通过原因和是否进入方案设计阶段的标记。这有助于团队成员快速了解项目中遇到的各种问题。
- 附议机制: 通过附议机制,确保只有经过团队认可的问题才会进入下一步,避免无效或低优先级的问题占用资源。
- 方案设计和审议:
- 设计方案: 对于进入方案设计阶段的问题,记录了相应的设计方案。每个方案都有编号、对应的问题编号、问题分类、方案描述、提出人和审议人员。这确保了每个问题都有明确的解决方案。
- 审议机制: 通过审议人员的审查,确保方案的合理性和可行性。
- 执行和检查:
- 执行记录: 记录每个方案的执行过程,包括执行人、方案详述和是否进入检查阶段的标记。这有助于跟踪方案的实施情况。
- 质量检查: 通过审查方案的执行结果,确保问题得到彻底解决,文档和代码的完整性。
- 文档归档和发布:
- 文档记录: 最终发布的问题解决方案和相关文档,便于后续查阅和维护。每个问题和方案都有详细的文档描述和文件位置。
- 发布管理: 通过记录最终的发布信息,确保所有问题的解决方案都得到了正式确认和发布。
项目开发记录步骤
- 问题记录 questions ,有其他人附议后进入下一步,无人附议不进入
- 设计方案,审议方案 motions ,提案人(一般是动议人,也可以是其他人)提出方案,审查通过后进入下一步。
- 计划执行 processes,执行人(一般是提案人,也可是其他人)执行方案,方案完成后进入下一步
- 计划检查 checking,审议人(不能只是开发人)审查方案执行结果,问题是否解决,文档是否完善。审议通过后发布问题解决方案
- 计划完成 release,最终记录,问题编号,方案编号,相关的资料。通过组件的话是组件位置和组件文档。
questions
| 问题编号 | 描述 | 提出人 | 附议人【无附议不进入 motion】 | 未通过原因 | 是否进入 motion |
|---|---|---|---|---|---|
| Q-0001 | andt 表格组件 Table 需要封装,样式还原原型,统一数据源接口,搜索,分页 | 张三 | 王五 | 是 | |
| Q-0002 | 使用 react-route v6 是,页面组件如何延迟加载 | 张三 | 使用 lazy 配置 | 否 | |
| Q-0003 | 面包屑导航组件需要与 UI 样式一致 | 张三 | 王五 | 是 | |
| Q-0004 | 项目常用到的antd组件,使用styled-components覆写样式为UI设计样式,实现UI设计的样式复用。 | 张三 | 王五 | 是 | |
| Q-0005 | andt组件Select不支持值集快码 | 张三 | 王持、李四 | 是 | |
| Q-0006 | 独立值集、批量值集查询,Map缓存优化 | 王五 | 张三、李四 | 是 | |
| Q-0007 | SimpleSearch搜索显示与UI不符,默认需显示前两行查询条件 | 李四 | 张三、王五 | 是 | |
| Q-0008 | intl多语言 |
王五 | 张三、李四 | 是 | |
| Q-0009 | table组件如何自定义空状态,满足UI设计 | 张三 | 王持、李四 | https://github.com/ant-design/ant-design/issues/14459 github的issue有对此问题的细节:使用table的locale参数,和antd的Empty组件即可完成空状态的组件级别自定义。 |
否 |
| Q-0010 | 字段解密组件 | 王五 | 张三、李四 | 是 | |
| Q-0011 | 静态文本配置展示 | 王五 | 张三、李四 | 是 | |
| Q-0012 | 图片骨架图loading过渡 | 王五 | 张三、李四 | 是 | |
| Q-0013 | 如何将多个路由路由对应为一个右侧菜单 | 张三 | 可以使用索引路由功能,使用父子结构,让一个多个字路由对应一个菜单,同时让父路由对应一个页面 对应文档:doc/菜单注意.md |
否 | |
| Q-0014 | SimpleTable根据UI修改默认分页大小和默认展示pageSize切换器 | 李四 | 张三 | 是 | |
| Q-0015 | SimpleSearch切换第二页后输入条件再次查询,无法正常显示数据 | 李四 | 张三 | 是 | |
| Q-0016 | SimpleSearch查询条件在点击其他按钮后,不需要自动折叠 | 李四 | 张三 | 是 |
motions
| 方案编号 | 问题编号 | 问题分类【通用组件,通用方案】 | 方案描述 | 提出人 | 审议人员【多人】 |
|---|---|---|---|---|---|
| M-0001 | Q-0001 | 通用组件【放入 components】 | 查找并封装 antd 组件 Table,Pagination,Seacrch,样式调整为 UI 设计稿。 | 张三 | 王持,张三 |
| M-0002 | Q-0003 | 通用组件【放入 components】 | 使用 styled-components 包装 antd 的组件 Breadcrumb | 张三 | 王持,张三 |
| M-0003 | Q-0004 | antd覆写组件【放入components/UI】 | 使用 styled-components 包装 antd 的组件 | 张三 | 王持,张三 |
| M-0004 | Q-0005 | 扩展antd的Select组件 | 增加值集的相关参数, lookupCode,textField,valueField,通过参数生成Options,原本的Select功能不会发生改变 | 张三 | 王持,张三,李四 |
| M-0006 | Q-0007 | 修改通用组件SimpleSearch | 将SimpleSearch组件内部使用的QueryFilter组件增加defaultColsNumber属性,控制默认显示数量为10 | 李四 | 王持,张三,李四 |
| M-0007 | Q-0008 | 编写核心intl模块 |
使用上下文全局包裹页面 | 王五 | 王持,张三,李四 |
| M-0009 | Q-0010 | 通用组件DecryptEye |
解密法人身份证、法人身份证地址等私密字段 | 王五 | 王持,张三,李四 |
| M-00010 | Q-0011 | 通用组件StaticText |
PC管理端配置静态文本,通过code查询 | 王五 | 王持,张三,李四 |
| M-00011 | Q-0012 | 通用组件SkeletonImage |
提升用户体验,避免因网络原因、加载失败的图片不友好展示 | 王五 | 王持,张三,李四 |
| M-00012 | Q-0014 | 修改通用组件SimpleTable |
在SimpleTable组件基础上,修改默认分页size为10,分页器内部增加showSizeChanger为true | 李四 | 张三,李四 |
| M-00013 | Q-0015 | 修改通用组件SimpleSearch |
在SimpleSearch组件基础上,点击查询时自动将页数重置为1 | 李四 | 张三,李四 |
| M-00014 | Q-0016 | 修改通用组件SimpleSearch |
在SimpleSearch组件基础上,在searchController里面增加collapsed和onCollapse去管理展开收起状态 | 李四 | 张三,李四 |
processes
| 在执行方案编号 | 执行人【多人】 | 方案详述 | 是否进入 check |
|---|---|---|---|
| M-0001 | 张三 | 1.抽离 table 的状态和数据到控制器,暴露出 table
渲染数据,seachController 和 pagenationController 写为
hooks。 2.将控制器和数据传入 Search,Table,Pagination,简单封装为 SimpleSearch,SimpleTable,SimplePagination 等纯逻辑组件完成表单交互 3.使用 styled-components 编写 Wrapper 组件包装纯逻辑组件完成与 UI 设计稿的一致性。 4.使用 React.Context 在 Wrapper 和纯逻辑组件之间传递 antd 组件 props 实现封装组件和 antd 组件 API 整合 5.使用 Wrapper 和纯逻辑组件封装开箱即用 Table,以覆盖多数场景 |
是 |
| M-0002 | 张三 | 使用 styled-components 包装 antd 的组件 Breadcrumb | 是 |
| M-0003 | 张三 | 使用 styled-components 包装 antd 的组件,不使用global全局样式修改,因为选择器权重不够时必须使用!import,这样会导致组件样式后续不好修改。 | 是 |
| M-0004 | 张三 | 增加值集的相关参数, lookupCode,textField,valueField,通过参数生成Options,原本的Select功能不会发生改变 | 是 |
| M-0006 | 李四 | 将SimpleSearch组件内部使用的QueryFilter组件增加defaultColsNumber属性,控制默认显示数量为10 | 是 |
| M-0007 | 王五 | intlDecorate高阶函数包装上下文消费者,需要使用多语言的组件,使用该函数包装 |
是 |
| M-0008 | 张三 | import { Empty } from 'antd' 使用table的local属性设置空状态,locale={ emptyText: <Empty image={Empty.PRESENTED_IMAGE_SIMPLE} description="aaaaa" /> } |
|
| M-0009 | 王五 | 编写decrypt解密函数,对每个字段单独生成函数,封装成组件,每个字段对应解密方法 |
是 |
| M-00010 | 王五 | 1. 通过PC管理端配置的textCode查询该条静态文本 2. 响应的 textCode是一段html字符串,使用dangerouslySetInnerHTML导入至html元素中 |
是 |
| M-00011 | 王五 | 1.
基于Ant Design的Skeleton.Image骨架图组件
2. const img = new Image(); img.onload = () => {}关联loading状态切换
3. 将加载后的图片资源,以 base64url传递给要绑定的图片 |
是 |
| M-00012 | 李四 | 在SimpleTable组件基础上进行修改: 1. 修改默认分页size为10 2. 分页器内部增加showSizeChanger为true |
是 |
| M-00013 | 李四 | 在SimpleSearch组件基础上进行修改:onFinish方法内部增加重置当前页数为1 | 是 |
| M-00014 | 李四 | 在SimpleSearch组件基础上进行修改: 1.增加queryFilterCollapsed状态,用于控制搜索条件是否折叠 2.searchController里面增加queryFilterCollapsed和setQueryFilterCollapsed属性 3.QueryFilter组件内部增加collapsed和onCollapse属性,通过onCollapse来设置展开收起状态 |
是 |
checking
| 可 check 方案编号 | 动议人 | 方案执行人【多人】 | 审查人【多人】 | 未通过原因 | 是否进入 release |
|---|---|---|---|---|---|
| M-0001 | 张三 | 张三 | 张三、王五 | 是 | |
| M-0002 | 张三 | 张三 | 张三、王五 | 是 | |
| M-0003 | 张三 | 张三 | 张三、王五 | 是 | |
| M-0004 | 张三 | 张三 | 王持,张三,李四 | 是 | |
| M-0006 | 李四 | 李四 | 王持,张三,李四 | 是 | |
| M-0007 | 王五 | 王五 | 王持,张三,李四 | 是 | |
| M-0008 | 王五 | 王五 | 王持,张三,李四 | 是 | |
| M-00010 | 王五 | 王五 | 王持,张三,李四 | 是 | |
| M-00011 | 王五 | 王五 | 王持,张三,李四 | 是 | |
| M-00012 | 李四 | 李四 | 张三,李四 | 是 | |
| M-00013 | 李四 | 李四 | 张三,李四 | 是 | |
| M-00014 | 李四 | 李四 | 张三,李四 | 是 |
release
| 问题编号 | 方案编号 | 文档描述 | |
|---|---|---|---|
| Q-0001 | M-0001 | 文档:doc/通用组件/SimpleTable;文件位置 components/SimpleTable | |
| Q-0003 | M-0002 | ||
| Q-0004 | M-0003 | 文档:doc/通用组件/UI设计稿关联组件;文件位置 components/UI | |
| Q-0005 | M-0004 | 文档:doc/通用组件/Select;文件位置 components/Select | |
| Q-0006 | M-0005 | 文件位置:@/api/index | |
| Q-0007 | M-0006 | 文件位置:src/components/SimpleTable/core | |
| Q-0008 | M-0007 | 文件位置:src/common/intl/index。语雀文档 | |
| Q-0010 | M-0009 | 文件位置:src/components/DecryptEye/index。语雀文档 | |
| Q-0011 | M-00010 | 文件位置:src/components/StaticText/index | |
| Q-0012 | M-00011 | 文件位置:src/components/SkeletonImage/index | |
| Q-0014 | M-00012 | 文件位置:src/components/SimpleTable/core | |
| Q-0015 | M-00013 | 文件位置:src/components/SimpleTable/core | |
| Q-0016 | M-00014 | 文件位置:src/components/SimpleTable/core |