[LIVECOPY-376] Revamp LIVECOPY documentation Created: 22/Nov/22  Updated: 12/Jan/23  Resolved: 12/Jan/23

Status: Closed
Project: Live Copy
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Story Priority: Neutral
Reporter: Alex Mansell Assignee: Alex Mansell
Resolution: Fixed Votes: 0
Labels: None
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: Not Specified Time Spent: Not Specified
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Sub-Tasks:
Key
Summary
Type
Status
Assignee
LIVECOPY-373 DOC: Integrate Use Cases and Base Req... Sub-task Completed Alex Mansell  
LIVECOPY-377 DOC: Migrate content to live copy mod... Sub-task Completed Alex Mansell  
LIVECOPY-379 DOC: Refactor structure (part A) Sub-task Completed Alex Mansell  
LIVECOPY-380 DOC: Update landing page Sub-task Completed Alex Mansell  
Template:
Acceptance criteria:
Empty
Task DoD:
[X]* Doc/release notes changes? Comment present?
[X]* Downstream builds green?
[X]* Solution information and context easily available?
[X]* Tests
[X]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Epic Link: LC enablement
T-Shirt Size: X-Large
Team: Documentation
Work Started:

 Description   

We need to revamp LIVECOPY documentation to reflect the use cases we want customers to use as well as simplifying the instructions and content to be easier to follow.

Requirements

  • Intro page (use cases outlined here along with introduction, etc.)
  • Dedicated use cases instructions (concise)
  • Establish docs in live module dev repo
  • Establish docs maintenance plan
  • Focus on "approved" use cases only
  • Dedicated changelog page

Resources

Inspiration

Important PM input

 


Generated at Mon Feb 12 02:28:07 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.