wake-0 / fhvOS

This repository contains an os for the arm cortex a8 in combination with beaglebone.
GNU General Public License v2.0
7 stars 1 forks source link

[General] Documentation #23

Closed wake-0 closed 9 years ago

wake-0 commented 9 years ago

Each documentation change, should be added to this "bug".

wake-0 commented 9 years ago

Would it be possible to move the existing mmu figures and code snippets to folders in the mmu folder? So that each module mmu, ipc, processmanagement, can fully be copied by its own without problems. I will add the folders for the move. @mpe5651

ghost commented 9 years ago

of course. I have to admit that's a really good idea! I'll take it on at latest by the weekend.

ghost commented 9 years ago

@Blackjack92 @trylimits

by the way: if you two guys need any UML diagrams, just tell me or send mi a rough hand drawing. I have a commercial licence for enterprise architect (probably the best tool for UML/SysML) and can create diagrams very easily.

wake-0 commented 9 years ago

I moved the existing mmu figures and code snippets to folders in the mmu folder. @mpe5651

trylimits commented 9 years ago

Subsection 2.4 "Zeitplan" refers to an unknown document (MS Project?!). Imo we should either add a screenshot of our schedule or get rid of that subsection. I commented out this subsection and pushed that version for the moment. @Blackjack92 Could you decide pls?

wake-0 commented 9 years ago

A screenshot is no good solution for this document (resolution, size, ...). Why should adding a reference to another document be a bad idea? The project file can be attached.

trylimits commented 9 years ago

From my point of view a documentation should be completely independent of other documents. Either a screenshot or appendix would be my suggestion. If we cannot do that, then my suggestion would be to not go into detail here. We submit the whole package (inc. MS Project file) anyway, so they have access to it if they are interested.

wake-0 commented 9 years ago

We need a file which explains what each "file" or "folder" contains. When the documentation is send by mail we have to explain it in the mail itself. So it is no problem for me, when this referencing is done.

trylimits commented 9 years ago

See new ticket. I will do that in the evening.

trylimits commented 9 years ago

Finally done :)