I’ve broken it down into sections for “User Guides”, “Installation/Upgrade Guides”, “Configuration Guides”, and “Developer Guides”. Figured this is a good way to start (nothing’s set in stone, which is why its on a wiki). I was hoping others would add pertinent documentation. The wiki is kind of a pain to use and the only way i’ve gotten screenshots to work is by putting links to them on my own server. So, tProbably not a good idea to forcing all docs on the wiki, but is a great place to link to your outside created docs if you don’t want to use the wiki.
Thank you for defining a starting point and a few “rules”. I would like to suggest one other thing for ALL; please note the date on the samples used, and realize it was 1.5 YEARS ago, which means WAY out of date. I would suggest we make all new screenshots, so that every one has 2009 on it. Let’s give users confidence that the instructions reflect what THEY will see. Thanks.
hey,
Also, regarding the separation of “User Guides” and “Configuration Guides”, I’ve been putting anything that requires action outside of OpenEMR in the “Configuration guides”. Figured it’d be useful in the end to separate these things; will even have categories that are in both (for example Pharmacy module). Again, all of this is flexible, and merely a starting point. Quite honestly, OpenEMR is starving for documentation and will take anything its given.
Joe,
geez, 1.5 years is way out of date… makes me feel old. This does make me wonder, again, why your using a XAMPP version from 2005; 4 years, that’s like a fossil
-brady
If Rod’s OK with it I’ll get my tech writer to start replacing the screen shots one-for-one. She’s working on a promo flash player demo of OpenEMR for me right now, then she can tackle that. It will be a good start, then we can tweak the text on the intro users guide to match.
Thanks to the XAMPP install, Sara (my Tech writer) has started the updates to the Users Guide to make it match with 3.0.1. It should not take her very long to get a new version out for review.
–Tony
I posted a question about billing process in the help forum … it’s documentation related and I get the feeling know one that knows actually looks there regularly…
We have about 40+ hrs into the documentation update at this point. Sometime early next week (Monday, I hope) we will be able to post a PDF Draft copy for review. It’s been a pretty big job due to major changes in the actual use case/work flow between the version 2 docs and the version 3 product.
Once I get some feedback on the draft will create the various view models, ie: PDF final, HTML view, and wiki updates.
The "source code" for it is an OpenOffice ODT file and the screen shot JPGs which we should check into the 3.0 tree, also.
It would be dang good to have a "help" menu item that would display the HTML version in an OpenEMR frame, I think.
We will not be updating the Ubuntu Server guide or the PhpGACL stuff.
I’d like to get a access control section (phpgacl) in there. The old manual is way outdated (no reason for users to even touch the original phpgacl controls). I could get this done quickly. If you could, just send me the ODT file of manual, and I’ll make the ACL section using same formatting etc. that your now using.
I hope you can post some HOWTOs on some of these issues you have worked out. As time goes by some of the really useful solutions we come here tend to get lost in a blur of messages over time.
I particular I am going to need help upgrading my copy of OpenEMR to catch all the new features you guys have added. I will need to convert from the old way to do phpGACL to the new way. I am not likely alone and a HOWTO will be useful.
Do upgrade from <3 to >3 it depends on answer to 3 questions:
1. Do you have php-gacl installed
2. Do you have sql-ledger installed
3. Is your admin user name ‘admin’
It can be very simple to complicated depending on your answers. (note it really doesn’t matter whether your using linux/windows)
Please look it over and give us feedback right here on this thread.
Brady - We’ll send you the ODT files to add the ACL stuff after we get a little feedback so we don’t cross the streams and blow up the world.
Also we will be posting my tech writers feedback from a users perspective of additional things that need to be documented as well as her enhancement requests; noted as they occurred during the process. This should be very useful as she had never used the system and had to learn it as she wrote to docs.
Once we think it’s solid we will produce HTML variants and post it to the wiki that way (might need help on that).
It looks great. Actually, no need to add the gacl stuff, since this manual seems more applicable to user instructions regarding basic clinic usage (gacl controls instructions in it would seem out of place). I’ll just post gacl tutorial by itself on the wiki for now.
Very cool. To simplify, when you have a version with indexing (some sort of table of contents so users can link to sections) in pdf or html can copy to oemr.org and just send a new window link to it(then will remove any links to the old outdated manual) from the wiki and popular links section. Actually integrating it into the wiki/xoops may be pain, and could deal with later if needed. You manual will be extremely useful; about 20% of oemr.org’s traffic is looking at the outdated manual.
-brady
I finaly took some time to evaluate the New OEMR 3.0.1 manual DEV.
A great piece of work! And do not have many suggestions for improvement. Since you are planning to make an index, I wonder if it could also be accompanied with some www.sites… to visit if you get into trouble. Or where you might find a solution on topics that won’t function as supposed.
Or may be I did not notice: a clickable link to www.OEMR.org where everything can be found.
