Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation needs a complete review. #3

Closed
7 tasks done
timlinux opened this issue May 7, 2013 · 1 comment
Closed
7 tasks done

Documentation needs a complete review. #3

timlinux opened this issue May 7, 2013 · 1 comment

Comments

@timlinux
Copy link
Contributor

timlinux commented May 7, 2013

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:

  • 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.

@ghost ghost assigned mach0 May 7, 2013
mach0 added a commit that referenced this issue Jun 5, 2013
mach0 added a commit that referenced this issue Jun 5, 2013
@mach0
Copy link
Contributor

mach0 commented Jun 18, 2013

Moved remaining points to #31

@mach0 mach0 closed this as completed Jun 18, 2013
mach0 added a commit that referenced this issue Mar 20, 2015
updating pics and material for InaSAFE 3.0 #3.0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants