TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

How do you document what you are learning at work?

6 pointsby seeyesover 9 years ago
We run a whole bunch of micro-services at work and I keep discovering things about them when I am reading through the code, fixing bugs, runbooks or whatever else. Right now, I have a note for every service and I keep appending to that. Evernote has some serious issues - no versioning, easy to totally delete the note (no warning). How do you all keep track of all the incremental learning?

10 comments

drl42over 9 years ago
Mindmaps, with notes. Allows you to organize the information in a visual hierarchy, so that you can quickly refer back to the notes. I use Freemind[1], an open source tool.<p>[1] - <a href="http:&#x2F;&#x2F;freemind.sourceforge.net&#x2F;wiki&#x2F;index.php&#x2F;Main_Page" rel="nofollow">http:&#x2F;&#x2F;freemind.sourceforge.net&#x2F;wiki&#x2F;index.php&#x2F;Main_Page</a>
e19293001over 9 years ago
If you&#x27;re using emacs you can use org-mode for note taking. Plus, there are lots of benefits wherein you can organize everything just in plain text.<p>Some of the previous discussions about org-mode:<p><a href="https:&#x2F;&#x2F;news.ycombinator.com&#x2F;item?id=2423276" rel="nofollow">https:&#x2F;&#x2F;news.ycombinator.com&#x2F;item?id=2423276</a><p><a href="https:&#x2F;&#x2F;news.ycombinator.com&#x2F;item?id=8668271" rel="nofollow">https:&#x2F;&#x2F;news.ycombinator.com&#x2F;item?id=8668271</a><p><a href="https:&#x2F;&#x2F;news.ycombinator.com&#x2F;item?id=2091850" rel="nofollow">https:&#x2F;&#x2F;news.ycombinator.com&#x2F;item?id=2091850</a><p>From org-mode website: Org mode is for keeping notes, maintaining TODO lists, planning projects, and authoring documents with a fast and effective plain-text system.<p><a href="http:&#x2F;&#x2F;orgmode.org&#x2F;" rel="nofollow">http:&#x2F;&#x2F;orgmode.org&#x2F;</a>
theGREENsuitover 9 years ago
I use OneNote. I have a Notebook for each project I&#x27;m on, with tabs to keep my notes organized. My small team, 3 people, has a shared OneNote Notebook to allow collaboration. At my previous employer, we used Atlassian&#x27;s Confluence.
katover 9 years ago
I have a few text files at work that I keep track of things. I treat it more as a reference file&#x2F;personal FAQ file, some notes are verbose and some are terse. When I am learning on a side project I keep my notes in Google docs. I take the time to format those notes better so I can study them easily. Google Docs has history and warns you when you delete a file. What do you use versioning for? I correct my notes when I discover they are wrong, and if we release a new version of the product, I just record the new behaviour in addition to the old behaviour (along with dates, build numbers etc)
atmosxover 9 years ago
I&#x27;m using tiddlywiki and I must say it&#x27;s doing an amazing job. It doesn&#x27;t stand on the way, works via mobile, everything is fine so far. I am slowly transitioning from Evernote. However if someone doesn&#x27;t pick-it-up it will probably cease[1] by the end of 2016.<p>[1] <a href="http:&#x2F;&#x2F;osmo-service.tiddlyspace.com&#x2F;ServiceUpdate20160112" rel="nofollow">http:&#x2F;&#x2F;osmo-service.tiddlyspace.com&#x2F;ServiceUpdate20160112</a>
davelnewtonover 9 years ago
Wiki, that way other people can contribute as <i>they</i> learn incrementally.<p>Wiki gardening is a thing, though, and without it, doom will follow.<p>At my last job we did the same thing, but I heavily customized the wiki to include endpoint testing, DB access, context-sensitive autocomplete, etc. It was pretty cool.
评论 #11036923 未加载
ApolloRisingover 9 years ago
I found Evernote was the easiest way to always have it around.
afarrellover 9 years ago
A directory of markdown files. I use git for version control.
tugberkkover 9 years ago
I just write them to text files and usually lose them.
SkyRocknRollover 9 years ago
I use gist.github.com