当前位置:网站首页>How to write a full score project document | acquisition technology
How to write a full score project document | acquisition technology
2022-07-05 17:09:00 【Acquisition technology】
original No taboo Get things Technology 2022-06-06 18:29 Published in Shanghai
1. background
When taking over a new project or periodically switching project development, or browsing community projects , Fast run The skill way to get up is usually called... Under the reading item README.md Document income .
The foregoing is only the first step in the long march , When you want to know the technology stack used in the project 、 Component library 、 Tool library and other materials required for development , When browsing the third-party package or business code module that depends on the management file , The result is often confused , A stable project warehouse is accompanied by business growth and technology upgrading , It is possible that there are many similar material libraries , Such as element ui、antd-vue、 Self developed component libraries coexist , How to choose and avoid the pit is unknown .
According to how the directory structure included in the project is divided during requirements development , Should the directory of the current business module be stored at will ; Whether the tools used in the development are available in the existing toolbox , Will there be repeated wheel making in the new addition ; How can the relevant person in charge of this business segment find , What is the domain name of each environment , What is the name of developing, testing and publishing applications , Which system does the interface authority or menu configuration belong to , Log in to the system and always prompt who has no permission to open it, etc , Numerous resistance, I believe that all readers are past people , Can resonate .
2. earnings
- Reduce initial project run The probability of encountering problems at the beginning , Various permission applications 、 System address access in each environment 、 Storage of function development directory 、 Inquiry of materials required for the project 、 Inquire about 、 The cost of agent configuration during communication and joint commissioning ;
- Increase demand focus , Focus on requirements interpretation and implementation , Use a pit avoidance guide ;
- Improve maintainability : Keep the development environment configuration consistent .
3. Content
Designed to help business project document writing guide
3.1 Project name
The name of the project is our primary concern in understanding the new project , For the creation of some project warehouses, we often encounter the difference of only a few letters , But the business is completely unrelated or not involved in the requirements , This can be misleading for a novice , Therefore, the name can also define a more important reference for us to search the target database in many warehouses .
3.2 development environment
(1) Operation preparation
Due to the coexistence of some new and old business projects and nodejs@version Version updates are released quickly , Running different projects often results in different versions by default , This causes an error to be reported on the console after switching the project .
In accordance with the H5 For front-end projects 、 from Git Warehouse down Drop it down , Subconsciously, you perform dependent package installation npm perhaps yarn Because that is a necessary prerequisite for running the project ; Therefore, it is necessary to indicate the type of package management tools used in the current project , Avoid using mismatched management tools for a long time due to habitual thinking, and be surprised to find that they are used incorrectly , The mood at this time is the most maddening waiting in the world , Dark moments that kill humanity .
H5 At present, the mainstream and well-known front-end are React、Vue、Angular etc. , The necessary technical stack description can give people a time to switch function ideas , Because it involves UI Component library selection is Antd-*、 Element-ui Or other mainstream component libraries , When developing requirements, we can also make clear whether we need to spend time to make some technical reserves before development 、 Need additional time to evaluate the needs .
Usually C End products do not require menus & Interface routing configuration , But for the B End system , Menu configuration is often required , In order to accurately test and release the completed functions to production , In most cases, you need to make your own menu 、 Interface routing configuration , But how can a novice quickly understand the configuration channel and the application that needs to configure system permissions , It is better to give the configuration document a direct link , Encountered permissions 、 When there is a configuration problem , Identify students who can seek support , Reduce damage to novices .
To ensure uniform code style 、 Inform the development team in advance of what configuration needs to be implemented for the current project 、 close IDE What plug-ins , Avoid using IDE Format plug-ins and projects ESLint Style conflict , This leads to a bunch of crazy red tips at runtime .
(2) Project start
For passing SSO Scenario of permission authentication , Most of them are authorized by verifying the legitimacy of the root domain name , In this case, it needs to be done locally hosts File binding localhost To the specified domain name , In order to obtain authentication normally during development .
Usually by yarn dev / npm run dev Default local development , However, the requirements of different business systems are different , It is differentiated according to the requirements of the backend and different projects , Clear instructions reduce the cost of multi environment retries or queries at startup .
For a new project or business , Re demand prd Or refer to which module during the review , For the novice at this time is blind , I don't know how to check the current status of this module , Therefore, direct links to products are particularly important , Because this is a quick access portal .
In most cases, the environment is more or less unstable during development 、 The environment is urgently occupied or involves access to other domains , It is necessary to configure the interface proxy , A clear and convenient configuration posture and directory are particularly urgent .
(3) Catalog Division
The representation :Markdown Tree structure , With tools tree Generate .
The division description of the project business module is also an indispensable and important part , Because when the corresponding business module function development is required , Yes, you need to know whether the relevant module exists 、 And where it is stored , It can enable future generations to quickly locate ; Perform corresponding operations or iterations on corresponding modules .
Iterations based on continuous version upgrades , The public part that conforms to the specific business scenario is gradually removed , As a public resource of the project e.g. Various components 、 Tool library 、 Network library, etc , Clear labels prevent novices from building wheels again .
(4)SDK file
For the introduction of some non community mainstream resources , For example, the two sides of the group or the minority 、 Adoption of third-party resources , It is recommended to paste the document into the document , In order to quickly read the documents when developing or troubleshooting problems , Avoid some unscientific Internet access in the case of no trace .
(5) A pit guide
When most people are less experienced in development, they are all new architectures 、 Version of the new boot project , Therefore, there are special scenarios such as historical reasons for the resource packages used for the projects involved , Ideas for solving problems during 、 A record of valuable experiences and experiences, such as the pits you have trodden on , Can help future generations avoid similar situations ;
(6) Project deployment
An important part of continuous integration is to deploy functions , At this time, with excited hands, I was ready to release , I don't know which door it is , So a clear application name and a direct link to the publishing system seem to make people look forward to it .
(7) Monitoring alarm
The development of software engineering has entered the polishing stage , An era when software products are still running naked has basically gone forever , Therefore, when the problem is fixed in the limited scenario during test acceptance , It is to observe the running health status in the production real user scenario 、 At this time, the monitoring connected to the project can be defined ;
3.3 Business Introduction
The business domain : Clearly describe the business domain of the project 、 Help create a quick business impression , In combination with the function description documents of each version under the business , It will help students to have a preliminary understanding of the business value behind the business ;
Iterative way : There are some differences in the requirements iteration methods adopted according to different businesses , There is a project system 、 Agile development method , For different iteration methods, the rhythm is also different ; The ways to promote project implementation are product driven or PMO The way , At present, most of them are the latter , A more efficient system is adopted in the acquisition RDC, It has the following features: MRD、PRD、 review 、 scheduling 、 Task assignment 、 Risk control 、 Human resources and other refined operation modes , The ability to implement the requirements and control them in an assembly line ;
Relevant personnel : Maintain the personnel involved in the project within the project 、 Update from time to time , It can help to quickly find relevant students for support when there are needs or troubleshooting problems , At least most of the time, you can help you find the students who participated in or understood the corresponding function points , Improve communication efficiency and other benefits .
3. summary
Project documentation is one of the best ways to quickly understand a project , It can be obtained that it is the service business , Participate in the development of the knowledge system , What preparations should be made before development , When you encounter problems, you can contact the corresponding students , It can not only help novices get started quickly , It also helps when multiple projects are in parallel , Switching between each other has the effect of warming up the past ; In short, an excellent project document should not only be understood by team members 、 Use it with ease , It also needs to be understood by other members 、 Only when it is done can its potential value be realized .
* writing / No taboo
Focus on Technology , Every Monday, three or five nights 18:30 Update technology dry goods
If you think the article is helpful to you , Welcome to comment and forward some likes ~
边栏推荐
- 腾讯音乐上线新产品“曲易买”,提供音乐商用版权授权
- Allusions of King Xuan of Qi Dynasty
- C# TCP如何限制单个客户端的访问流量
- npm安装
- Jarvis OJ simple network management protocol
- Jarvis OJ 远程登录协议
- Use JDBC technology and MySQL database management system to realize the function of course management, including adding, modifying, querying and deleting course information.
- Iphone14 with pill screen may trigger a rush for Chinese consumers
- How can C TCP set heartbeat packets to be elegant?
- Summary of PHP pseudo protocol of cisp-pte
猜你喜欢
Android privacy sandbox developer preview 3: privacy, security and personalized experience
阈值同态加密在隐私计算中的应用:解读
Jarvis OJ Flag
Scratch colorful candied haws Electronic Society graphical programming scratch grade examination level 3 true questions and answers analysis June 2022
【729. 我的日程安排表 I】
Hiengine: comparable to the local cloud native memory database engine
The first EMQ in China joined Amazon cloud technology's "startup acceleration - global partner network program"
一个满分的项目文档是如何书写的|得物技术
Judge whether a number is a prime number (prime number)
Using C language to realize palindrome number
随机推荐
Embedded UC (UNIX System Advanced Programming) -3
flask解决CORS ERR 问题
Hiengine: comparable to the local cloud native memory database engine
【剑指 Offer】66. 构建乘积数组
2022 年 Q2 加密市场投融资报告:GameFi 成为投资关键词
Wsl2.0 installation
[Web attack and Defense] WAF detection technology map
Etcd 构建高可用Etcd集群
【beanshell】数据写入本地多种方法
Games101 notes (III)
国内首家 EMQ 加入亚马逊云科技「初创加速-全球合作伙伴网络计划」
Jarvis OJ Flag
外盘期货平台如何辨别正规安全?
【7.7直播预告】《SaaS云原生应用典型架构》大咖讲师教你轻松构建云原生SaaS化应用,难题一一击破,更有华为周边好礼等你领!
CMake教程Step6(添加自定义命令和生成文件)
Embedded -arm (bare board development) -1
Combined use of vant popup+ other components and pit avoidance Guide
时间戳strtotime前一天或后一天的日期
npm安装
Browser rendering principle and rearrangement and redrawing