From ad620c7bef50894a796831764dfee66ab766e770 Mon Sep 17 00:00:00 2001 From: mwapst <163834242+mwapst@users.noreply.github.com> Date: Thu, 27 Jun 2024 17:05:14 +0100 Subject: [PATCH] Documentation update Moved Design and Project Management pages into Developer Added Delivery Plan to Proj Mgt --- docs/Design/Approach.md | 2 +- docs/Project Management/DeliveryPlan.md | 51 +++++++++++++++++++++++++ mkdocs.yml | 20 +++++----- 3 files changed, 62 insertions(+), 11 deletions(-) create mode 100644 docs/Project Management/DeliveryPlan.md diff --git a/docs/Design/Approach.md b/docs/Design/Approach.md index 819be60..b17432e 100755 --- a/docs/Design/Approach.md +++ b/docs/Design/Approach.md @@ -8,6 +8,6 @@ the Extensions. The numbered steps in the Extensions correspond to the MSS steps Some use cases (eg, maintaining investigators) and components (eg audit activity) are called by other use cases, (eg, create a proposal, edit a proposal). Such items are declared just once and referenced by name with a bold italic hyperlink. Click the hyperlink to see the detail and then return with the browser back button. -The data models can be found [***here***](https://github.com/ivoa/ProposalDM). +The data models can be found in a [separate project](https://ivoa.github.io/ProposalDM/). The UI is documented elsewhere. \ No newline at end of file diff --git a/docs/Project Management/DeliveryPlan.md b/docs/Project Management/DeliveryPlan.md new file mode 100644 index 0000000..8a6cbde --- /dev/null +++ b/docs/Project Management/DeliveryPlan.md @@ -0,0 +1,51 @@ + +# ***Delivery Plan*** + +Planned Delivery dates + +Phase 1 : + +Phase 2 : + +Phase 3 : + + +| Epic | Story | Phase 1 | Phase 2 | Phase 3 | +|-----------------------|-----------------------------------------------------------------------------------------------|---------|---------|---------| +| Manage Reference Data | UC02 Create observatory admin | Phase 1 | | | +| | UC03 Configure observatory | Phase 1 | | | +| | UC 04 Create new proposal cycle | Phase 1 | | | +| | UC08 Create TAC Chair | | Phase 2 | | +| | UC09 Add TAC members | | Phase 2 | | +| | UC16 Assign internal reviewer | | Phase 2 | | +| | UC17 Assign external reviewer | | Phase 2 | | +| | | | | | +| Deploy System | UC00 Deploy the system | Phase 1 | | | +| | UC01 User registers to the system | Phase 1 | | | +| | | | | | +| Assemble Proposal | UC05 Create observing proposal | Phase 1 | | | +| | UC06 Edit observing proposal | Phase 1 | | | +| | UC07 Submit a proposal | Phase 1 | | | +| | UC15 Import whole proposal | | Phase 2 | | +| | UC20 Clone proposal | | Phase 2 | | +| | UC21 Withdraw proposal | | | Phase 3 | +| | | | | | +| Consider Proposal | UC10 Review proposals | | Phase 2 | | +| | UC11 Score proposals | | Phase 2 | | +| | UC12 Assign observing time | | Phase 2 | | +| | UC13 Inform PIs about allocation | | | Phase 3 | +| | UC18 Review proposal scores | | Phase 2 | | +| | UC22 Revoke allocation | | | Phase 3 | +| | | | | | +| Common | UC14 Export whole proposal | | Phase 2 | | +| | | | | | +| Manage Hardware | Procure, configure, and deliver Dev application servers,with agreed standby | Phase 1 | | | +| | Procure, configure, and deliver Stage and Production application servers, with agreed standby | | Phase 2 | | +| | | | | | +| Manage DBMS | Procure, configure, and deliver Dev database servers, with agreed standby | Phase 1 | | | +| | Procure, configure, and deliver Stage and Production database servers, with agreed standby | | Phase 2 | | +| | Implement database security | Phase 1 | | | +| | Implement agreed data backup strategy | Phase 1 | | | +| | | | | | +| Statistics | Monitor Production system usage | | | Phase 3 | + diff --git a/mkdocs.yml b/mkdocs.yml index f665927..f948816 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -24,18 +24,18 @@ nav: - Architecture: Developer/architecture.md - Data Model: Developer/ProposalDM.md - API: Developer/api.md + - Design: + - Approach: Design/Approach.md + - Purpose and Scope: Design/PurposeAndScope.md + - Business Requirements: Design/BusinessRequirements.md + - Business Rules: Design/BusinessRules.md + - Components: Design/Components.md + - Non-functional Requirements: Design/NFRs.md + - Project Management: + - Project Management: Project Management/ProjectManagement.md + - Delivery Plan: Project Management/DeliveryPlan.md - Deployment: - Getting Started: Deployment/index.md - # 2024-06-24 mwa design and proj mgt - - Design: - - Approach: Design/Approach.md - - Purpose and Scope: Design/PurposeAndScope.md - - Business Requirements: Design/BusinessRequirements.md - - Business Rules: Design/BusinessRules.md - - Components: Design/Components.md - - Non-functional Requirements: Design/NFRs.md - - Project Management: Project Management/ProjectManagement.md - # 2024-06-24 mwa theme: name: material features: