Jump to content
  • Advertisement
Sign in to follow this  
Xer0botXer0

What's a good way to document information

This topic is 386 days old which is more than the 365 day threshold we allow for new replies. Please post a new topic.

If you intended to correct an error in the post then please contact us.

Recommended Posts

Hi guys,

So something I'd find useful is having like a reference book/cook book for the languages I'm learning.

For example I'm currently busy with a tutorial that's talking about client/server networking in java, so far I've written the code and made a bit of sense on what's going on, how ever I want to break things down by line, like how you'd go to oracle to see what the documentations say about the difference libraries, their methods, exception types and all that. I'd like my own version that only has what I've already learnt or what I'm currently learning/what's relevant. 

I'm looking for a way to create documents and then organize them so they're easily accessible and navigable , I'm sure if I were a better programmer I would make something like that but I'm more a game dev, so what do you use(if any) to do this sort of thing ? do you know of any software like that ? I'm finding crap on google and thought well other developers may use something of the sort. 

I used to use a book and write down what I've learnt into sections so I could look back for quick reference. But I'm not a fan of my handwriting and I type much faster. 

Share this post


Link to post
Share on other sites
Advertisement
2 minutes ago, Xer0botXer0 said:

I used to use a book and write down what I've learnt into sections so I could look back for quick reference. But I'm not a fan of my handwriting and I type much faster. 

It's also not as quickly searchable :P

Several programmers I know have used various note-taking applications for exactly this purpose. Writing down gotchas, important bits and pieces, etc. Of the ones I remember being mentioned are EverNote and OneNote.

Share this post


Link to post
Share on other sites

I usually either write this kind of stuff in the code itself, in large header comments on the file that serves as the primary interface to the API in question, or in plain text files that live in a "Documentation" sibling directory and are authored using some flavor of Markdown or reStructuredText so they can be compiled into nice-looking HTML if needed.

Share this post


Link to post
Share on other sites

I'm thinking about keeping a collection of code that's relevant to each other in some documentation, I'm going to look at evernote it looks promising!

Share this post


Link to post
Share on other sites
Sign in to follow this  

  • Advertisement
×

Important Information

By using GameDev.net, you agree to our community Guidelines, Terms of Use, and Privacy Policy.

We are the game development community.

Whether you are an indie, hobbyist, AAA developer, or just trying to learn, GameDev.net is the place for you to learn, share, and connect with the games industry. Learn more About Us or sign up!

Sign me up!