So many doubts regarding documentation

[LeopardChurch]

Greetings.

 

I am currently studying (well, here’s called information engineering, not sure how it’s called else where in the world) long story short.

I have a lot of doubts regarding documentation and diagrams, UML and BPMN does any one recommend a good book / website that can help me understand these concepts?

 

Thanks before hand.

[trag1c]

I don't know of any books but for documentation but it should be done in such a way that if you died someone can read those docs and pick up right where you left off.

[sparkle128]

I don't know of any books but for documentation but it should be done in such a way that if you died someone can read those docs and pick up right where you left off.

Or somewhere there abouts.

 

Documentation is like sex: when it is good, it is very, very good; and when it is bad, it is better than nothing.   -- Dick Brandon (?)

 

Personally I've done soo much of it and seen so much of it done. Its outdated the second its created, but is valuable to give you a general idea. Most of the developers I know might do a very precursory look at the docs and then just look at the code and figure it out.

 

For a high level of how to break it down and what to start with, this might help

 

http://poslis.fon.bg.ac.rs/index.php?option=com_docman&task=doc_download&gid=235&Itemid=35

[burnttoastnice]

Greetings.

I am currently studying (well, here’s called information engineering, not sure how it’s called else where in the world) long story short.

I have a lot of doubts regarding documentation and diagrams, UML and BPMN does any one recommend a good book / website that can help me understand these concepts?

Thanks before hand.

There's a project that my college is working on where we have to build an electric car to pass a 60 minute endurance race, while being the most efficient. I'm in charge of programming a system to monitor the energy consumption of the vehicle, as well as the speed and a live video feed back to the pits, and this all has to happen over Wi-Fi until my college obtains a UHF license.

The documentation of the system contains all the information regarding turning the system on (for normal users) as well as login credentials for the on-board code editor. Logging into that reveals further documentation describing parts of the system, like which daemon processes in charge of what, as well as which pages contain code for which section. The layout of the system code makes it pretty easy for someone else to come along and edit it if needed.

Make sure your documentation basically contains information on how to use the system, as well as modifying it when needed.

[LeopardChurch]

 

Thanks I'll check it out. although I know what documentation is for, what I'm having trouble with is assembling the documentation, like sequence diagrams and the such.