6 ms·
Honest, the issue with documentation is the killer. Not on just how to build SOA, but on what parts of it to document (AS MUCH AS YOU CAN is the right answer).
by pydanny 14y ago
Honest, the issue with documentation is the killer. Not on just how to build SOA, but on what parts of it to document (AS MUCH AS YOU CAN is the right answer).
Nothing is worse then coming into an SOA project and discovering that you have to explore the code of many repos to figure out the logic behind the components that make up a project. Or that you have to explore Word/Google documents.
Part of SOA is the contract between applications. If you don't document the API contract then you've got an abstracted mess often built with conflicting coding styles. And, unfortunately, this seems to be the majority of SOA implementations I've seen for the past umpteen years.
- rdegges 14y agoTotally. In general though, developers need to write better documentation for any application--not just SOA stuff. There are tons of private applications running in production that are obfuscated as hell, and have no supporting documentation :( Thanks for the comment! :D
- deleted 14y ago[deleted]
- kenneth_reitz 14y agoThat's what I love the most about it. You can't not have excellent documentation. Forces you to do it right :)
- deleted 14y ago[deleted]
- kenneth_reitz 14y agoThis has nothing to do with Heroku.
- deleted 14y ago[deleted]