OSDev.org

The Place to Start for Operating System Developers
It is currently Thu Mar 30, 2017 6:48 am

All times are UTC - 6 hours




Post new topic Reply to topic  [ 2 posts ] 
Author Message
 Post subject: i am going to do a documentation but contemplating what kind
PostPosted: Tue Jul 19, 2016 12:47 pm 
Offline
Member
Member

Joined: Wed Nov 18, 2015 3:04 pm
Posts: 215
Location: San Jose San Francisco Bay Area
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?

_________________
key takeaway after spending yrs on sw industry: big issue small because everyone jumps on it and fixes it. small issue is big since everyone ignores and it causes catastrophy later. #devilisinthedetails


Top
 Profile  
 
 Post subject: Re: i am going to do a documentation but contemplating what
PostPosted: Tue Jan 03, 2017 10:39 pm 
Offline
Member
Member
User avatar

Joined: Sun Dec 25, 2016 1:54 am
Posts: 181
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!

_________________
Plagiarize. Plagiarize. Let not one line escape thine eyes...


Top
 Profile  
 
Display posts from previous:  Sort by  
Post new topic Reply to topic  [ 2 posts ] 

All times are UTC - 6 hours


Who is online

Users browsing this forum: No registered users and 3 guests


You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot post attachments in this forum

Search for:
Jump to:  
Powered by phpBB © 2000, 2002, 2005, 2007 phpBB Group