• How to let the front end students get familiar with the project as soon as possible and get started with the development of new requirements as soon as possible;
  • How to complete the handover in the shortest time with high quality when the project needs to be handed over due to organizational structure adjustment or staff turnover;
  • How to avoid online accidents caused by unknown risks in historical project iterations;
  • How to improve human efficiency and dynamically adjust the developers of each project;
  • How to achieve continuous integration of project description documents

These are All practical problems that the front-end development team is facing and needs to solve. In this regard, I would like to share with you the All In Docs program that I promoted and implemented In our group, and you can happily complete the handover of the project with just a look In your eyes

In plain English, the All In Docs solution is known as an enhanced version of readme.md. Documentation (specification) is the first step, and All information related to project background requirements, development, test and deployment can be queried In the document. In practice, the All In Docs program seems to take time, but In fact, it not only improves the handover efficiency, but also improves our usual development efficiency, which is composed of the following documents

Basic Project Informationbase.md

  • Project background
  • The warehouse address
  • Access to the entry
  • Adaptive device, terminal,APPandOSversion
  • NginxConfigure the link
  • Jenkinslink
  • Agilelink
  • configurationLinks,cdnEtc configuration file
  • Monitoring platform link
  • Buried point management links
  • sentrylink

Project Iteration informationchangelog.md

  • Per iterationJIRA.PRD WIKI.The UI blue lake.API WIKI.Swagger UI
  • Per iterationMENBER, includingPM.UI.UE.FE.BE.QA
  • Task breakdown for each iterationtodoAnd the correspondingddl
  • Per iterationflowLink for trackingCode Review.Merge RequestwithTag

How to run a projectrun.md

  • configurationnpm startOne-click startup,webpack-dev-serverNecessary to automatically open the browser and configure the page to openqueryString
  • If you need to cut the source, configure it.npmrcFile, or innpm scriptsaddnpm install --registry=http://registry.xxx.com.cn
  • If you need to plantcookieAnd the attachedcookiethekey-valueAmway,edit this coookieThe plug-in
  • Attached to each environment interfacepoxyconfiguration
  • If the interface requires authentication, attach login links and user accounts and passwords for each environment
  • If you need to configure/ect/hosts, how to configure it
  • If you need to usecharles, how to configure it
  • If you need to customizeUserAgentInfo, attached how to configure amwayUser-Agent SwitcherThe plug-in

Access links to various environmentslinks.md

  • includingdev.test.pre.prodThe environment is necessary to spellqueryStringFull link to
  • If there is a background management system, attached to each environment background management link, the corresponding account, attached how to open permission
  • Accessible account passwords for each environment
  • If it helps in some waysdkAnd attach asdkDocuments and related to each environmentappId

The file directory structure of the projectdir.md

Describe the file directory structure of the project with trees and comments

Project pages and business processes with screenshotsdoc.xmind

A picture is better than a hundred articles. Xmind with screenshots and words is used to describe the overall business logic process of the project

pitholes.md

  • Various potholes encountered during the development and testing process and online, which took a long time to solve, or which may cause online accidents

Problem Repair Recordfixlog.md

  • Work order record of user feedback, including work order link, cause of problem, fix plan

To dotodo.md

  • Project experience optimization, performance optimization, code optimization, architecture optimization to do list
  • Prioritize and expect development lead time

In addition to these documents, the owner of each project is institutionally responsible for reviewing the document updates for each project Merge Request