afry-south / dragonfly-fcb

ÅF Dragonfly Quadrotor UAV Project
Other
7 stars 3 forks source link

Separate theory and implementation in documentation #124

Closed stenbergd closed 9 years ago

stenbergd commented 9 years ago

Perhaps it's a good idea to have separate documents on theory and code design and implementation.

Theory:

Implemenation:

adam-at-epsilon commented 9 years ago

The only difficulty I can foresee with having two documents is the usability of the documentation on the part of the reader.

If we have one document, we can click cross-references back and forth between theory and implementation, if we have two different documents this back-and-forth clicking is not possible because links in PDF cannot open other PDF documents as far as I'm aware.

stenbergd commented 9 years ago

I guess.

But regardless it would generally be nice to separate these theory and implementation. Perhaps in chapters then.

adam-at-epsilon commented 9 years ago

Yes I agree they should be separate chapters. If the documents get too big & unwieldy to edit & maintain perhaps we should split them into separates.

stenbergd commented 9 years ago

Then maybe this is a non-issue at this moment in time. Closing.