A collection of useful resources for software engineers, and others.
FOR EDUCATIONAL PURPOSES ONLY.
The idea of these documents are to be sort of a graph database, each file is a node representing a topic or idea.
Files are roughly named, with optional topic prefixes, e.g. language, or interview.
We adopt a sort of Reverse DNS notation, going from the general to the specific, i.e. general-more-most-specific; e.g. software-apps-windows.
Currently hosted at github.com/streetchief/KnowledgeBase.
Either browse the online repository, or for easier browsing, clone the repository locally and browse with your favorite editor.
There is a ton of useful information in the knowledge folder. I have tried to streamline the resources; specific tech will be prefixed with software, and more general concepts will start with programming. Apologies if I broke any links.
We also have:
- copies of 3rd parties resources mapped to Markdown, like
power-verbs.mdin the assets folder - scripts like
generate-journal-page.shin the tools folder - file templates like
generic-node-script.mjsin the templates folder - documentation for contributors like
how-to-use-licensing-info.mdin the docs folder
Tip: when browsing github{dot}com, press the t key to bring up a fuzzy file search.
A.k.a. Personal Knowledge Management (PKM).
Possibly using:
- Obsidian - a powerful and extensible knowledge base that works on top of your local folder of plain text files.
- Obsidian Dataview - Treat your Obsidian Vault as a database which you can query from.
- Digital Gardening in Obsidian
Alternatives:
- Roam Research - A note-taking tool for networked thought.
- Dendron - very new; vscode plugin only.
The pillars of pragmatic system design from The Pragmatic Programmer, 20th Anniversary Edition by Thomas and Hunt:
- Version Control Systems (VCS)
- Automated Testing
- Full Automation
Please feel free to contribute!
See the contribution guide for details, but for now the TLDR is: keep it simple.
The source code used in this project is licensed under the GNU GPL v3.0, and the content is licensed under Creative Commons Attribution-NonCommercial 4.0 International Public License, where applicable.