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

restructuring the whole documentation #31

Closed
4 tasks done
mach0 opened this issue Jun 18, 2013 · 1 comment
Closed
4 tasks done

restructuring the whole documentation #31

mach0 opened this issue Jun 18, 2013 · 1 comment

Comments

@mach0
Copy link
Contributor

mach0 commented Jun 18, 2013

Problem

The current documentation is now compiling without any errors but going through the whole documentation you can see that there is a lot of redundant information and probably miss located documentation which should be moved and collected under an other topic.

Suggested Solution

Collecting missing issues from #3

  • logical consistency (e.g. each section following on logically from the previous) - proposed in restructuring the whole documentation #31
  • clear and up to date screenshots - to be done before the 1.2 release
  • current and correct information relating the use and functionality of InaSAFE - some developer info is still not up to date
  • 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. - waiting for new structure

There is the Idea of having it structured like that:

  • Landing page: short info about whole stuff like it is in the upcoming landing page
  • General: General info about the Project
    • About
    • News
    • Press Material (scientific-references)
    • Changelog
    • Current Release Information (activities)
  • Tutorials
    • Material that should be kept together as one but just branded as InaSAFE Tutorial to be able to just take a tutorial out of that section and work through it with a class or any audience
    • Tutorials should either have a subdirectory here or might probably consist of only one .rst file (like the tutorial.rst is now)
    • current socialisation from here should be split up into topics and moved one level up into tutorials
    • We need to investigate what parts should stick together and what can be taken out as separated tutorial
  • User MANUAL(User Documentation)
    • Beside the Tutorials a brief overview about every function you can use in InaSAFE
    • for example.. the current changelog from here I suggest to move up to General because to me a changelog has nothing to do with a User Manual

See the DocumentationStructure as produced and updated it lucidchart

Adding persons here:
@timlinux
@emirhartato
@wonderchook

@mach0
Copy link
Contributor Author

mach0 commented Jul 19, 2013

next step will be developer documentation
user documentation is fixed (except #46)

@mach0 mach0 closed this as completed Jul 19, 2013
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