|
|
|
### Team level (team members-to-team members)
|
|
|
|
|
|
|
|
* Provide links to documents and make sure that external documents has sufficient access.
|
|
|
|
* <span dir="">Do not be verbose or repetitive; be</span> <span dir="">concise and make your points clearly</span>.
|
|
|
|
* <span dir="">Avoid the use of jargon or undefined technical language</span>.
|
|
|
|
|
|
|
|
**Source code**:
|
|
|
|
|
|
|
|
* Repository access details
|
|
|
|
* Describe the different access and roles, e.g. developer, maintainer, etc.
|
|
|
|
* Other details that requires additional security access, e.g. VPN, etc.
|
|
|
|
* Description of key algorithms and design patterns
|
|
|
|
* Describe the main logic flow.
|
|
|
|
* Describe the design pattern and how it is being used.
|
|
|
|
* Specification of classes and app’s layers
|
|
|
|
* Provide a tree structure and describe each components.
|
|
|
|
* Creating accounts with the required rights
|
|
|
|
* (Optional) If there are requirements for this and who will be the contact person.
|
|
|
|
* Getting all configuration scripts and requirements for developers' workstations
|
|
|
|
* (If possible) Create automated scripts for environment deployment or creating system images – to save precious time for the developers.
|
|
|
|
* (Optional) VS Code Devcontainer for frontend and backend applications.
|
|
|
|
|
|
|
|
**Internal processes and workflows**:
|
|
|
|
|
|
|
|
- Deployment guidelines, system configuration and installation, operating instructions, troubleshooting, changelog, and bug tracker data
|
|
|
|
* Describe the tools we are using.
|
|
|
|
- Software development workflow
|
|
|
|
* Describe the process of our activities and workflows, e.g. Agile process, SDLC, DSM, etc.
|
|
|
|
* Provide diagram if possible.
|
|
|
|
- Branching strategy
|
|
|
|
* Describe the git branching strategy we are using for this project, e.g. gitflow.
|
|
|
|
- Software development tools and techniques
|
|
|
|
* Describe the tools we are using, e.g. linters, code editors, REST clients, code analysis tools, etc.
|
|
|
|
- CI/CD best practices
|
|
|
|
* Describe the workflow and provide diagram if possible.
|
|
|
|
|
|
|
|
**Access to the systems used team-wide**:
|
|
|
|
|
|
|
|
For access, provide details on how we can acquire access and the contact details of support team.
|
|
|
|
|
|
|
|
- Access to the existing environment and third-party systems
|
|
|
|
* Provide details on the following
|
|
|
|
* Delivery and environment system:
|
|
|
|
* CI/CD pipeline
|
|
|
|
* Type of infrastructure, e.g Jenkins, Gitlab CI, etc
|
|
|
|
* Test infrastructure
|
|
|
|
* Test plans and workflows, test environments, etc.
|
|
|
|
* Monitoring, Observability, and Logging access
|
|
|
|
* Splunk, AWS Cloudwatch/CloudTrail, etc
|
|
|
|
|
|
|
|
**<span dir="">Documents</span>**<span dir="">:</span>
|
|
|
|
|
|
|
|
* <span dir="">Description of business requirements</span>
|
|
|
|
* <span dir="">Project roadmap</span>
|
|
|
|
* <span dir="">Software architecture documentation</span>
|
|
|
|
* System architecture
|
|
|
|
* Sub-system architecture
|
|
|
|
* Architecture in terms of technical infrastructure
|
|
|
|
* Architecture in terms of business tasks, use cases
|
|
|
|
* Team's technical debts
|
|
|
|
* All technical findings and proposals regarding the existing system
|
|
|
|
* <span dir="">Database structure</span>
|
|
|
|
* Entity relationship diagram (ERD)
|
|
|
|
* <span dir="">Data dictionary and schema</span>
|
|
|
|
* Sample DB dump with data for migration workflow
|
|
|
|
* <span dir="">Design files: mockups, graphics</span>
|
|
|
|
* <span dir="">User stories</span>
|
|
|
|
* <span dir="">Test cases</span>
|
|
|
|
* <span dir="">User (manual) documentation</span>
|
|
|
|
* User accounts:
|
|
|
|
* Testing/staging/production user accounts for testing the product
|
|
|
|
* Accounts in the client's systems (AWS, etc) |
|
|
\ No newline at end of file |
