Mainframe is a place where dev knowledge lives _
We built Mainframe to give developers at Viget a place to share and discover opinions and insights about the tech we use.
A place to record and find insights, opinions, suggestions, gotchas, and tips related to specific tools, libraries, and technologies we've used in the past. It endeavors to bridge the gap between institutional knowledge locked away in the minds of engineers and documented project takeaways hidden in unfindable Google docs.
Mainframe is a chronicle of hard-earned lessons that future engineers can reference and benefit from.
Mainframe is NOT a set of comprehensive guides or tutorials, nor is it a place where discussion happens.
As you work with new tools, libraries, and technologies, take note of information you would have liked to have known before you started. Be especially mindful of pitfalls, footguns, trade-offs, and time vampires.
After technical retrospectives, add the Project to Mainframe and add any Topics that came up in the retrospective. Then, add Observations to the Topics.
- Descriptive without being wordy
- Includes recommendations on when to use or not use a tool, library, or technology
- Focuses on technical trade-offs
- Explains shortcomings in contrast with other comparable solutions or approaches
- Includes links to relevant resources or suggested alternatives
- Saves other engineers time and sanity
- Helps other engineers answer the questions "Should I use this thing?" and "When?"
If you have feedback or feature requests, please file an issue on the repo.