-
Type: User story
-
Status: Open
-
Priority: Minor
-
Resolution: Unresolved
-
Affects Version/s: None
-
Fix Version/s: QualifiedToSchedule
-
Component/s: Help & Documentation
-
Epic Link:
As a Studio user, I can see that my feature documentation is made as a specific file, because:
- I can edit it separately from the main feature
- The file is saved as soon as I confirm my changes or when focus is not on the editor anymore
=> This allows me to handle a possible conflict separately for the feature itself and its documentation, so that the documentation is not overridden for a bad reason .
When in simple mode:
=> A commit is generated for each documentation change
In Intermediate / Advanced modes:
=> A work in progress is saved for each documentation change and I can decide when to commit
A link between the feature and its documentation is kept either through a naming convention or a feature property. If this is done through a naming convention, when the main feature is renamed the documentation file is renamed accordingly.