What's the Best Documentation You've Used?
Documentation is very important for us developers as it guides us to build what we need using a tool or service. When the documentation is great, the developer experience feels seamless. When the documentation is incorrect, missing details, or not clear, we struggle building with the tool.
What was the best documentation you've used? It can be for any framework, service, or tool. Also, what made this documentation so useful to you?
P.S: atMedusa, we're currently in the process of revampingour documentation to provide a better developer experience. If you're interested in contributing to an open-source project, you can always check out currentgood first issues orreport any issues you find in the documentation.
Top comments(19)
- EducationGeorgian Technical University
- WorkSoftware Engineer
- Joined
Best documentation I've ever used was for IBM Notes (former Lotus Notes) Designer.
Almost every object. every property, every method were described and contained usage examples.
- Email
- LocationLebanon
- WorkTechnical Writer @ Medusa
- Joined
Seems like IBM doesn't support it anymore but IBM generally have good documentation!
- EducationGeorgian Technical University
- WorkSoftware Engineer
- Joined
IBM has ruined IBM Notes and sold it to HCL.
Long time ago IBM Notes was a main platform to build groupware solutions. But "genius" IBM managers just ruined this product, it became outdated, companies who used this product for years switched to other products and as a final step, IBM sold this product to HCL.
HCL tries to resurrect it, but I think it could not be done, time is lost.
- Email
- LocationLebanon
- WorkTechnical Writer @ Medusa
- Joined
From what I can tell it's something similar to Notion right?
- EducationGeorgian Technical University
- WorkSoftware Engineer
- Joined
I have no experience with Notion, checked it now, yes, it looks like HCL Notes (former IBM Notes, and Lotus Notes).
HCL Notes presents mail, calendar, todo, discussions in an integrated environment, also you can build your own application (called databases), that utilize all these capabilities. Multi-platform, web-enabled, mobile, etc etc.
More info:
- EducationGeorgian Technical University
- WorkSoftware Engineer
- Joined
Also, Notion is a SaaS (software as a service) product as I understand. HCL (IBM, Lotus) Notes/Domino can be installed on a company's premises and used in an isolated environment (for extra security purposes, classified document processing, etc etc).
- Email
- LocationLebanon
- WorkTechnical Writer @ Medusa
- Joined
Ah makes sense. Well it definitely must have been a loss for the users who were using it!
- LocationScotland
- EducationSomething something cybernetics
- PronounsThey/them
- WorkGeneral-purpose software person
- Joined
Probably theZX Spectrum Plus 2 user manual.
- Email
- LocationLebanon
- WorkTechnical Writer @ Medusa
- Joined
Interesting! What do you think makes it a good documentation?
- LocationScotland
- EducationSomething something cybernetics
- PronounsThey/them
- WorkGeneral-purpose software person
- Joined
It walks you through everything from the basics of BASIC to machine code and port mappings for the Z80. As a kid, I learned so much about programming from it.
- Email
- LocationLebanon
- WorkTechnical Writer @ Medusa
- Joined
I've used the Symfony documentation before and it's definitely detailed and useful
- LocationColombia 🇨🇴 (not Columbia)
- WorkContent, Courses & Training for .NET teams — Helping teams to write maintainable & performant code
- Joined
Stripe API docs...
- Email
- LocationLebanon
- WorkTechnical Writer @ Medusa
- Joined
No doubt!
Django has the best docs I have ever seen.
- Email
- LocationLebanon
- WorkTechnical Writer @ Medusa
- Joined
Never tried it but sounds interesting to take a look at! what do you think makes it the best?
- Email
- LocationNew Delhi, India
- PronounsHe/Him
- WorkPrincipal Engineer
- Joined
By far the best documentation so far in terms of rich content and usability.
For further actions, you may consider blocking this person and/orreporting abuse
