61–70 of 110 posts
to use open source, wiki is not structured and i really don't like that much, folder-files are hard to manage once you have many files.
CMS could be used(e.g. drupal), however I hope CMS can support markdown _natively_ which is not the case for now.
I have spent so much time to find ways to organize knowledge myself, to no avail, I use drupal 7 along the year, which is not great, but I could not find anything better.
Recently we started using Slinkky https://www.slinkky.com . It makes organizing information for your team and company really simple. There's a 30 day trial for startups so there's no loss if it doesn't work out. You can collaborate on personal boards with coworkers and add team spaces for shared content. You can restrict permission by user so only admins and managers can add content to team boards.
Earlier quoted context omitted.
> Each line of code was documented Wow. Every line. There is such a thing as too many comments or too liberal use of comments in code.
Not if the system fails on a Monday morning at 3am after 20 years without issues and needs to be fixed before the business opens. Having comments for every line helps fixing it dramatically. For most code it will be overkill but there are some companies where it's integral for core systems.
The best rule of thumb is, make the code so clear that it is itself a comment, and only if the code cannot relay the meaning, then add a comment.
Slite.com (YCW18) serves exactly this purpose. Full disclaimer it's my company, but this is the core issue we are tackling. 2 classic pitfalls with knowledge are - what do you put in this word (for instance are meeting minutes "knowledge"?) - how static you think it should be If you only envision knowledge as static processes, traditional wikis work. If you want all your team to contribute and for this knowledge base…
Edit: I see https://news.ycombinator.com/item?id=16476388
I've found that the tool doesn't matter as much as the company culture. You need to foster a culture of documentation for EVERYTHING. It doesn't matter if you have the best tools in the world if nobody uses them. Too often this falls by the wayside because documentation of processes and preserving institutional knowledge, while extremely important, isn't the type of work that gets recognized or rewarded. If anyone ca…
The motivation is simple, the implementation is more difficult.
People will document things if they feel as though they derive a personal (read -> personal, not party) and immediate benefit from doing so. That's it.
This is why getting motivated to doing unit tests is so difficult. There are many long term and group benefits, but the immediate and personal benefits are limited (especially in relation to the amount of effort).
Try https://www.notion.so ! It combines docs, wikis, and todos; it's collaborative, and it's beautifully designed. It's perfect for building knowledge bases for teams. (Disclaimer / I worked there in the past)
At my company I do internal nurture marketing (thank you MixMax) to remind employees to use knowledge resources, and to contribute to them.
Try https://www.notion.so ! It combines docs, wikis, and todos; it's collaborative, and it's beautifully designed. It's perfect for building knowledge bases for teams. (Disclaimer / I worked there in the past)
At a glance, it looks like a product that's stored on the company's servers. Why would any company, startup or dinosaur, want to put their knowledge base and documentation in the hand of a new pretty and fancy product that might fold next month? There's no Linux download, no github, and especially, no server - I stay away from products like that, sorry.
Almost every company uses external services for this sort of thing right now. Google Drive, Confluence, whatever. Notion allows you to export to PDF/Markdown as well.
https://www.notion.so/Export-to-PDF-or-markdown-5406d98f17d2...
It is really simple, everyone who can use Word can use it. It is also very wiki-like in that it is quick to edit, searchable (and fast), versioned and it is easy to see when something has changed (bold tabs).
Personally I used to prefer dokuwiki (and before that I made a custom tool in Javascript to simplify use of mediawiki to document procedures.)
Somewhat of an odd option, but we use Trello cards since we live in Trello anyway. Two of the most frequently used boards: a "Handbook" for employee matters and "Customer Knowledge" where we distill custdev and sales conversations into topic cards. Just paste in new information into the comments section and then work it into the summary in the card description. You can also assign each topic to have an owner to make…
Very much still working on it :)