Two open source projects with great architecture documentation
1–10 of 38 posts
Re: Two open source projects with great architecture documentation
#2Does anyone have other examples of projects with this level of architecture documentation?
Re: Two open source projects with great architecture documentation
#3Re: Two open source projects with great architecture documentation
#4It made me reflect on my own work and side projects, how I could improve the docs to make things easier to understand for myself and others. As I've grown as a developer, I've been writing more and more documentation, same with tests, to a point where some projects have more tests and docs than the actual code itself.
I've heard it said that writing good documentation requires a different set of skills than writing code. Sometimes a person who is not technical or focused on development can be better at explaining things. At the least it requires a different perspective, to target the human runtime.
I'll also add that automatically generated docs can be very useful, not by themselves only, but as an additional reference.
Re: Two open source projects with great architecture documentation
#5- gdb manual
Re: Two open source projects with great architecture documentation
#6Re: Two open source projects with great architecture documentation
#7"The biggest deficiency in the free software community today is not in the software—it is the lack of good free documentation that we can include with the free software." - gdb manual
Re: Two open source projects with great architecture documentation
#8Re: Two open source projects with great architecture documentation
#9I was ever working actively on Apache Kvrocks, an alternative for Redis on Flash. And we benefit a lot from Redis docs to catch up its command. In comparison, Kvrocks docs is clearly "less than awesome".
In my $DAYJOB, I convince my boss that the docs, at least the README is important, as you show the esbuild example here.
Here are two patches to improve the README of it:
* https://github.com/GreptimeTeam/greptimedb/pull/3528
* https://github.com/GreptimeTeam/greptimedb/pull/3522
That in #3522 firstly, I tried to reduce the content and "offload" the detailed docs into the doc site. And in #3528, I found that heading elements center align is still fancy and we need some short, clear introduction and advantages.
Anyway, a good product is the leading 1 and docs is the following 0. Without a good product, no good docs can be present.
Re: Two open source projects with great architecture documentation
#10It has some interesting insights.