Wiki User Guide - Clean up and Move to Wiki

[lvanfretti]

• [ ] - User Documentation

The user documentation should include:

• [ ] - Introduction (as in "RaPId_quickStart.docx")
• [ ] - Required Dependencies
• [ ] - Installation (explaining the automated script and displaying the prompts)
• [ ] - Functionalities (Deeper Description in "RaPId_quickStart.docx")
• [ ] - Appendixes:
• [ ] - FMU Generation using JModelica (as in "RaPId_quickStart.docx")
• [ ] - FMU Generation using MapleSIM ( @tinrabuzin you can populate this in the Wiki after you do the job for Mike)

@MaximeBaudette the idea of the Wiki I think is the best approach so people can provide input and examples. The examples should not go in the "user manual", but instead in an "Application Guide". @tinrabuzin and I will work in the application guide (similar to the one done for iPSL) in the coming weeks after the workshop and we have completed the paper for RaPId and iPSL.

There are several files in the ./Documentation that need to be cleaned up. I propose the following is done:

• Delete .pdf files, as they can't be edited by users.
• Keep the original .pptx (2012 and 2013) in a folder with name and the RaPId_quickStart.docx to "./pre_release_documentation_materials"
• If User Manual.docx has been updated, we can keep it where it is, but it should be replaced by the wiki. The User Manual.docx should include the list of authors, and track changes. It should also have the iTesla logo and information about the project that is missing in "RaPId_quickStart.docx". If doing the wiki is easier than editing the Word file, I suggest we drop the word file and put everything in the wiki. In such case, we just need to put a file in the folder with a link to the wiki, and to mention that in the "./pre_release_documentation_materials" there are materials that can be useful to users but might be outdated (we keep them for the time being though).

[MaximeBaudette]

Good News @lvanfretti the Wiki is a GIT repo in itself ! It is therefore very easy to follow the evolution :smiley:

[MaximeBaudette]

A good example of what can be achieved with a wiki https://github.com/snowplow/snowplow/wiki @tinrabuzin there are some things specific to the wiki syntax and organization that I have to talk to you about so you don't get lost when dealing with it

[lvanfretti]

Awesome!

[MaximeBaudette]

@tinrabuzin Inspired by the example linked above, I have uploaded to the wiki an empty structure, you can fill in the files :smiley_cat: Let me know if you have any questions about how to work with the wiki, it is not so intuitive.

[tinrabuzin]

@MaximeBaudette @lvanfretti

Should we find some time in the following week to discuss how you'd like the User Documentation and Application Guide to look like? Or should I just work on it and see how it'll turn out?

[lvanfretti]

Let's post-pone this until I'm back from the USA. I think we have now to prioritize in writing the iPSL paper and finishing the RaPId paper - both for Elsevier Software X.

Luigi

On Thu, Nov 5, 2015 at 11:54 PM, tinrabuzin [email protected] wrote:

@MaximeBaudette https://github.com/MaximeBaudette @lvanfretti https://github.com/lvanfretti

Should we find some time in the following week to discuss how you'd like the User Documentation and Application Guide to look like? Or should I just work on it and see how it'll turn out?

— Reply to this email directly or view it on GitHub https://github.com/SmarTS-Lab/iTesla_RaPId/issues/13#issuecomment-154221794 .

[MaximeBaudette]

From @lvanfretti

@janlav document all the information contained in RapidObject and what is needed to run a script.