You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Attrition is a natural occurrence in documentation. We need to prevent this by regularly checking that it is current and correct.
Proposed solution
Manually review each and every page of documentation for the following elements:
consistent writing style
consistent use of markup
logical consistency (e.g. each section following on logically from the previous)
valid and up to date intra and extra document links
clear and up to date screenshots
current and correct information relating the use and functionality of InaSAFE
all sections having an appropriate anchor so that we can 'hook' into that context from the program code to display localised help for a given context.
Expected outcome
When a user uses the documentation he should encounter clear, logical and consistent text that helps him / her achieve the tasks they are trying to carry out.
The text was updated successfully, but these errors were encountered:
Problem
Attrition is a natural occurrence in documentation. We need to prevent this by regularly checking that it is current and correct.
Proposed solution
Manually review each and every page of documentation for the following elements:
Expected outcome
When a user uses the documentation he should encounter clear, logical and consistent text that helps him / her achieve the tasks they are trying to carry out.
The text was updated successfully, but these errors were encountered: