-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Create artifact-checklist.md * Update artifact-checklist.md * Update artifact-checklist.md * fix: update content and layout --------- Co-authored-by: Thanh Pham <zlatan.pham@gmail.com>
- Loading branch information
1 parent
0c5e075
commit 0005b06
Showing
1 changed file
with
49 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
--- | ||
tags: | ||
- operations | ||
- checklist | ||
- delivery | ||
title: 'Checklist: Back up Artifact' | ||
date: 2024-07-22 | ||
description: To make sure that project’s progress is aligned with the team plan, we collect artifacts every 3 months and save as record of what was done. | ||
authors: | ||
- minh_cloud | ||
- thanh | ||
--- | ||
|
||
### Why do we need artifacts? | ||
|
||
- Track the project’s progress against the plan, making it easier to manage and control | ||
- Future team members can learn from past projects, understanding the decisions made, the problems faced, and how they were solved | ||
- Smoothen the handover and onboarding process, track record, and trace back if needed. | ||
|
||
### Artifacts Checklist | ||
|
||
Every 3 monts, we update and synchronize project charters and artifacts below. | ||
|
||
1. Backup all source codes | ||
- [ ] If applicable, establish a pull process to back up all source code | ||
2. Project charter | ||
- [ ] Description: What is the purpose of the project and which problem the product solve? | ||
- [ ] Project scope: Which function our team involved our team? | ||
- [ ] Tech stack: Which tech stack our team provide? | ||
- [ ] Stakeholders: Who you work with and their roles | ||
- [ ] Resource allocation: Which role is assigned to whom? | ||
- [ ] Meetings: When the meeting is setup and for which purpose | ||
- [ ] Communication channels | ||
- [ ] Changelog: Link to the current changelog directory which record the updates of the team’s work | ||
3. Milestones/roadmap | ||
- [ ] What would the team do in the next 3 months? | ||
4. Document | ||
- [ ] High-level diagrams (with description for the function of each component) | ||
- [ ] ERD or class diagram | ||
- [ ] Container diagram | ||
- [ ] Component diagram | ||
- [ ] Infrastructure diagram | ||
- [ ] Flow, activity or state machine diagrams for core or complex features | ||
- [ ] README | ||
- [ ] Project description | ||
- [ ] How to install and run source code | ||
- [ ] How to contribute (coding convention, explanation of source structure and architecture…) | ||
- [ ] .env document | ||
- [ ] Potential issues, roadblocks |