This biggest complaint I have heard from Sugar developers, both community and partner, is about our documentation. And with any software project, both open-source and closed-source, it is always a major struggling point.
We’ve taken an approach with the Developer’s Guide to create a cohesive manual that gives a large technical overview of the platform. This guide has been very helpful for many developers to learn how the platform works. That said, we’ve had lot’s of feedback about this handling our developer documentation in such a way, namely:
- It’s very high level and not practical. The focus is about the concepts in the application but really doesn’t show very good examples of how you would actually do it.
- It’s quite large and hard to grep ( so to speak ). Not as useful for a reference due to it’s length and high-level approach to the problem.
- There’s missing an API reference for much of the classes in the application.
- There’s nowhere where we list what has changed from a developer perspective in each release ( like new or changed functions, new upgrade-safe hooks, etc )
I think a big focus of our documentation is filling these voids, and making the documentation more approachable by everyone. While I’d love to have a larger conversation about this at SugarCon in April to get more community and partner input, I also want to get feedback now on the direction we should take and what other shortcomings we have with our documentation. Sound off in the comments or DM us on Twitter with your thoughts.