i am going to do a documentation but contemplating what kind

[ggodw000]

I have been blogging on the progress of writing kernel which is kinda scribble but once i gain steam, i am contemplatig these days to make it more presentable format, so that it can be reflected on my resume. Since i am not in graduate school, i dont think it can be done in academic quality (i.e. research paper or thesis) since it is done by guidance.
So I am thinking how to proceed on this one.
I was thinking perhaps do a documentation that may in some way resembles research paper using the online research writing guidance and even though it can not be treated as real research paper, still it is a very high quality paper.
Has anyone done it?

[dchapiesky]

gitbook.... https://www.gitbook.com/

gitbook editor... https://www.gitbook.com/editor

Cheers....

other solutions less easy to deal with...

www.doxygen.com

but worthy because of source code cross-reference and a ton of add ons for many different languages

I use both.

Gitbook for introductory material, research, etc...

doxygen for actually linking from source code back into gitbook via links

doxygen also integrates with MSC http://www.mcternan.me.uk/mscgen/

which I have found quite useful for documenting the sycall back-and-forth, etc....

cheers!