NGE Documentation Layout Proposal

[MasterGod]

I'm creating the documentation for my engine, NGE, and I'd like to hear your opinions about the current layout I had in mind before I start writing it all:

Code: Select all

Index:
	Preface:
1.	Title Page
2.	Index

Introduction:
1.1	Terminology
1.1.1	3D Graphics
1.1.2	Game Engine
1.2	A bit of history
1.3	Overview
1.4	Purpose
1.5	License

Programming:
2.1	Overview (Irrlicht, IrrKlang and other external libraries will be described here)
2.2	Sub Systems (namespaces descriptions)
2.2.1	Core
2.2.2	I/O
2.2.3	Audio
2.2.4	GUI
2.2.5	Engine
2.2.6	Game

Design:
3.1	Design Overview
3.2	Structure Design
3.2.1	Behind the scenes of NGE
3.2.2	User related

Development:
4.1	Overview
4.2	Schedule (The dates it took me to accomplish certain parts of the engine)

Tools:
5.1	Overview

Acknowledgments:
	List of thanks

[xray]

A documentation is really useful and absolutely needed in such a project. I would even say that it is needed in every bigger project to get a good overview also for the developer to keep all things in mind. Unfortunately most amateur developers dont like this section...

Your doc structure looks quite tidy. Maybe a section "5.2 Compiling the engine" ? Will there be a physic engine integrated?

[MasterGod]

Thanks for the replay.
I've also changed it a bit but a section about how to compile the engine could be good. Thanks.

[Vsk]

You are a smart guy MasterGod, can I tak a revenue share of your engine .
A 50% will be me happy. .

[MasterGod]

Thanks.

P.S
Did you see this? - The actual docs.