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.

Ask HN: How do you document your knowhow, past projects and lessons?

44 pointsby selmatover 7 years ago
Previously, I did use gmail drafts, but now I use private installation of doku-wiki for documentation of my design, schemes, know-how, created source code (git module), lesson learned.<p>Wondering what use HN community, if there is better way or tools for that.

31 comments

vijucatover 7 years ago
OneNote. The hierarchical breakdown of Notebook, Section, and Pages is quite useful. I use one page as a linear, chronological &quot;Plan for today&quot; journal, with links to subject matter on other Pages that naturally get organized into Sections (ML learning, Coursera - Scala, Health, Attitude &#x2F; Thinking, etc;).<p>Evernote&#x27;s Search is much better than OneNote&#x27;s (Windows&#x27; Search), searching seamlessly even inside attachments, but I absolutely hate the look of Evernote pages; just a personal thing. Could be something as simple as Tahoma vs. Calibri, but I think it&#x27;s more than that...OneNote really looks good to my subjective eye. Plus I like the keyboard shortcuts.<p>For PDFs, get really good at whatever Reader you use w.r.t. annotation tools. I love PDF-Xchange Viewer for annotation (a Windows product).
评论 #16186409 未加载
评论 #16188098 未加载
评论 #16186519 未加载
评论 #16186478 未加载
xemokaover 7 years ago
Using markdown, in a SublimeText project, with MarkdownExtended, Markdown Preview, project search (using ripgrep), imagePaste (to paste from clipboard to a file in a .&#x2F;.images directory along with the image markdown syntax), and a folder hierarchy that organises notes into general topics and filenames with project&#x2F;contents descriptors.<p>I also write all my lectures this way and output to slides using backslide (remark.js).<p>I have two text files always open, `_inbox.md` (all unorganized incoming notes) and `_work.md` (tasks list and dates).<p>I&#x27;ve tried a bunch of different things and this is the only thing I seem to stick to. I sync it to multiple machines with BoxSync and keep it all in a git repo (for when I care about tracking changes, usually my commits are weekly, with useless commit messages).
agentultraover 7 years ago
For my own work:<p>A Leuchtterm1917 dotted notebook + mechanical pencil + ink&#x2F;gel hybrid pen.<p><a href="https:&#x2F;&#x2F;www.amazon.com&#x2F;gp&#x2F;product&#x2F;B003ENUIKC&#x2F;ref=s9_acsd_hps_bw_c_x_5_w" rel="nofollow">https:&#x2F;&#x2F;www.amazon.com&#x2F;gp&#x2F;product&#x2F;B003ENUIKC&#x2F;ref=s9_acsd_hps...</a><p>For work I do under employment I tend to use org-mode and publish to whatever format suits them best. Often one of PDF, HTML, or Markdown.<p>I have been experimenting with using an org-mode based publishing system that syncs with my ReMarkable... it is taking over <i>some</i> of my note-taking. But I&#x27;m a chronic journal-keeper and have over a decade of notes and experience with my system.
评论 #16186389 未加载
评论 #16187381 未加载
timrichardover 7 years ago
Markdown to Evernote, but I&#x27;m also keen on embedding little screencasts in my notes. It&#x27;s sometimes a great memory jog to have an old terminal session reanimated and popping up in response to your keyword search results.<p>It&#x27;s also been useful for a &#x27;show rather than tell&#x27; approach to technical Confluence documentation.<p>I&#x27;ve previously used LICEcap and Screenflow, but SnagIt also has some nice video capture options, with an option to convert to animated GIF. Also becoming a bit of a fan of Camtasia, but the output is regular video.
alienrebornover 7 years ago
Used to use Quiver (<a href="http:&#x2F;&#x2F;happenapps.com&#x2F;" rel="nofollow">http:&#x2F;&#x2F;happenapps.com&#x2F;</a>) but now switched to Bear Notes (<a href="http:&#x2F;&#x2F;www.bear-writer.com&#x2F;" rel="nofollow">http:&#x2F;&#x2F;www.bear-writer.com&#x2F;</a>).<p>Both support Markdown and Syntax Highlighting. Quiver is lot more full featured programmer&#x27;s notebook but I like Bear because its light and I prefer tag system.
评论 #16187504 未加载
评论 #16190214 未加载
评论 #16196402 未加载
michael-axover 7 years ago
I used google-drafts, wikis, all sorts of combos involving folders &amp; files &amp; hardcopies before discovering org-mode 4..5 years ago.<p>Since then I&#x27;ve been able to forge 20 years of references, scans, pdfs, application-code!, shell scripts, photos, glyphs, graphs, fonts into an exo-brain (a nice word from the cool kids) that not only includes journals, time &amp; billing, ledgers, feeds, project and resource planning, play-books &amp; checklists for my own debriefing<p>into something version controlled that boots from a chroot and can transfer to android devices. i can now find, use and profit from clusters of notes, generate html and latex, read, write and code, interface with and even capture just about anything that life has thrown at me since i started re-tooling myself.<p>I&#x27;ve got a reminder&#x2F;drill mechanism which picks high-level topics things for me to review and i just go with that to remember and refine old stuff as i go. Its a seething mess of useful.<p>In essence .. i tag, sort, sift, condense and categorize like everyone else. In under a gig of ram, and, as it happens, at the speed of thought via a consistent user-interface.<p>And yeah, of course i use a browser. I can capture&#x2F;convert html to plain text &amp; drag images into files knowing that everything will always be hyperlinked by not-too-obnoxious uuids.<p>For some reason I had to hold my nose delving into emacs after ignoring it for 20 years. It seemed so weird. Now that I&#x27;ve gotten used to working with software that enables general purpose computing, I&#x27;m experiencing Ataraxia.<p>Anyhow, to the OP, check your net-present-value figures. Are you expecting to be a knowledge worker for a while? Have you ever chosen a slightly harder path to make things easier?<p>If so, just take this note as a hint for what&#x27;s possible when you&#x27;re seriously looking to answer your own question :)
jryan49over 7 years ago
I&#x27;m testing out tiddlywiki (<a href="https:&#x2F;&#x2F;tiddlywiki.com&#x2F;" rel="nofollow">https:&#x2F;&#x2F;tiddlywiki.com&#x2F;</a>) as of right now. I really like it so far. Used to use org-mode, then plain old google docs. Right now for me it&#x27;s between onenote and tiddlywiki.
评论 #16187155 未加载
fiveFeetover 7 years ago
I use vim &lt;<a href="http:&#x2F;&#x2F;www.vim.org&#x2F;&gt;" rel="nofollow">http:&#x2F;&#x2F;www.vim.org&#x2F;&gt;</a> and zim &lt;<a href="http:&#x2F;&#x2F;zim-wiki.org&gt;" rel="nofollow">http:&#x2F;&#x2F;zim-wiki.org&gt;</a> to maintain my collection of notes which are primarily text. Both tools work well on Linux and Windows.<p>Zim is great if you need some type of markup (ex:- hyper links, bullet points etc.,). Vim is great for plain text.<p>If the notes are private but need to be shared across multiple machines, I create a private gitlab project.<p>If the notes are public, I either create a github project or put them on a public wiki where only I can edit. For the public wiki, I am using an account on shoutwiki &lt;<a href="http:&#x2F;&#x2F;www.shoutwiki.com&gt;" rel="nofollow">http:&#x2F;&#x2F;www.shoutwiki.com&gt;</a> .
zimablueover 7 years ago
I&#x27;ve spend a long time trying different methods of doing this.<p>I briefly investigated tiddlywiki, used OneNote heavily for a while.<p>Currently I&#x27;m migrating to using JupyterLab notebooks on an ec2 instance with IP whitelisting.<p>It works pretty well, I have a kind of dream to connect it to a Datomic server instead of using filesystem notebooks and have relational notes.
评论 #16188116 未加载
评论 #16187045 未加载
j_sover 7 years ago
I am interested in personal experiences&#x2F;anecdata documenting what happens to these collections when the collector dies. So much effort invested!<p>I plan to make sure organizational time pays off in the short term, and need to work up a &#x27;site map&#x27; for my various digital collections (in the off chance anyone cares after I&#x27;m gone). Sharing as much as possible starts to make sense in the long term, so classifying what &quot;must be private&quot; must be done as part of the process. (A tiny bit of this aspect is reflected in how useful my own StackOverflow contributions have been across jobs!)<p>In this light, tools encouraging sharing useful specific technical info semi-privately within a small group of very close professional friendships start to make a lot of sense.
评论 #16187869 未加载
csbartusover 7 years ago
Using a Wordpress theme for it with all post formats supported (link, quote, aside, etc)<p><a href="https:&#x2F;&#x2F;mothemes.baby" rel="nofollow">https:&#x2F;&#x2F;mothemes.baby</a><p>If you want to try (in test mode now) send me an email to the address from my profile
shooverover 7 years ago
That is an interesting use of gmail drafts. I&#x27;m sure you stretched the usability to the limit and found pros and cons going to a wiki.<p>I use orgmode, starting with a buffer with a few headings, URLs, and paragraphs on a topic. The buffer may be killed the same day or turn into 100k words spread over a few files a few years later, still easily searchable with org-agenda or grep and automatically exported to HTML for viewing on mobile. I don&#x27;t bother with images or mobile editing due to complications--those are the main drawbacks.
juliansamarjievover 7 years ago
While building my company, we just drop all our experiences, lessons learned and failures down in our blog. It helps us document the process, be able to look back at it, as well as hopefully provide a valuable blueprint for other people building a business.<p>We&#x27;ve been doing it from day 1 and realise how valuable is and will be, going forward. <a href="https:&#x2F;&#x2F;weardulo.com&#x2F;blogs&#x2F;origins" rel="nofollow">https:&#x2F;&#x2F;weardulo.com&#x2F;blogs&#x2F;origins</a>
chaselyover 7 years ago
I write things down and then transfer what is useful to digital with org-mode.<p>Depending on the &quot;officialness,&quot; I write things down on either a legal pad or in a lab notebook dedicated to a project. Then the most important bits of this gets put into an org-mode &quot;notebook.&quot;<p>I prefer writing things down first, I find that it sharpens my thinking around whatever I&#x27;m recording.<p>Though there are some other interesting ideas in here that I may try and steal.
rubidiumover 7 years ago
Relevant from 73 days ago: &quot;Ask HN: How does your team handle knowledge documentation?&quot; <a href="https:&#x2F;&#x2F;news.ycombinator.com&#x2F;item?id=15637194" rel="nofollow">https:&#x2F;&#x2F;news.ycombinator.com&#x2F;item?id=15637194</a><p>My answer is the same. The tools don&#x27;t matter much at all when it comes to documenting knowledge. Whatever gets used is best. Searchable is a plus.
nikiviover 7 years ago
I use GitBook and GitHub.<p>I have a repository with many markdown files (<a href="https:&#x2F;&#x2F;github.com&#x2F;nikitavoloboev&#x2F;knowledge" rel="nofollow">https:&#x2F;&#x2F;github.com&#x2F;nikitavoloboev&#x2F;knowledge</a>) and I render it all with GitBook here (<a href="https:&#x2F;&#x2F;wiki.nikitavoloboev.xyz" rel="nofollow">https:&#x2F;&#x2F;wiki.nikitavoloboev.xyz</a>).
VladimirGolovinover 7 years ago
Diaries in Workflowy, per project. Top-level &quot;folders&quot; for years, second level for months, third level for days.
nerdponxover 7 years ago
At the moment it&#x27;s a collection of Markdown files in a Git repo. I&#x27;m thinking about moving to a wiki solution but I haven&#x27;t settled on one yet.<p>Has anyone used multiple wikis and can comment on the pros and cons? There are so many out there. The only one I know I don&#x27;t like is Tiddlywiki.
评论 #16186278 未加载
评论 #16186193 未加载
CameronBangaover 7 years ago
nvALT is growing on me as of late. Very quick and easy way to build a library of markdown notes.
dahx4Eevover 7 years ago
Boostnote (<a href="https:&#x2F;&#x2F;boostnote.io" rel="nofollow">https:&#x2F;&#x2F;boostnote.io</a>). Writing markdown in vim mode, annually rotated, version controlled with SparkleShare.
loliveover 7 years ago
What&#x27;s your opinion about online Markdown editors backuped by Github Pages? Something like <a href="http:&#x2F;&#x2F;prose.io&#x2F;" rel="nofollow">http:&#x2F;&#x2F;prose.io&#x2F;</a>
cg94301over 7 years ago
Using Python Sphinx. Compiles markdown to html. Searchable, TOC, index. <a href="http:&#x2F;&#x2F;www.sphinx-doc.org&#x2F;" rel="nofollow">http:&#x2F;&#x2F;www.sphinx-doc.org&#x2F;</a>.
jamespoover 7 years ago
emacs org mode self hosted mediawiki
jluover 7 years ago
A Dropbox folder full of markdown files with some custom syntax for quick jotting down ideas and knowledge, worked great for the past couple of years.
m_ransingover 7 years ago
I use CherryTree. I use it as simple editor application (not code editing though) and also use its&#x27; hierarchical structuring of the notes.
vaughanover 7 years ago
I use IntelliJ&#x2F;WebStorm. I open a Google Drive folder which contains a markdown file for each day.
quantum_nerdover 7 years ago
Github Gist, Bear Note taking app(hashtags, hierarchical ordering, etc) and sometimes jrnl cli tool
billconanover 7 years ago
GitHub gist, google drive(why Gmail drafts?), mediawiki
dvaita99over 7 years ago
Markdown. Synced to github and Gitlab.
Darkstackover 7 years ago
a .plan file for my todo list, and some Markdown files synced on github.
peterbradenover 7 years ago
Simplenote &#x2F; github