3

Having had to deliver/create documentation on numerous projects now, I know it is the last thing that anyone wants to do manually in Word.

I happened to see this tool mentioned: https://zkniebel.gitbooks.io/sitecoreuml/

Looks pretty promising for UML diagrams and is bi-directional.

Are there any other tools out there that assist with documenting Sitecore solutions? In particular, documenting the Sitecore Templates, their inheritance, fields, presentation details, etc? Bonus for documenting Sites (and subsites) and IA (Information Architecture), etc. Ideally looking for a complete solution documentation.

If they are bi-directional, like Sitecore UML, even better. As this allows you to not only document, but keep the documentation updated as changes to the templates, etc. occur.

Improve this question
1
  • 2
    Honestly, the closest thing you are going to get is Sitecore UML. I don't know of any other documentation available, short of TDS or Unicorn files. Maybe there is an opportunity to add something on to those serialization processes to create additional documentation, but to my knowledge, that doesn't exist out in the wild.
    – Pete Navarra
    Dec 11, 2017 at 23:38

1 Answer 1

Reset to default
1

If the code is well documented with XML comments, you can use Sandcastle. It's been discontinued by Microsoft, but I have used it in the past. It will generate MSDN-like documentation in html that is easily navigable.

Improve this answer
1
  • Thanks @AaronHawkins - this will definitely help with documenting code, but I am actually seeking other options similar to the SitecoreUML / StarUML functionality. As a minimum, a way to document the Sitecore Templates, their inheritance, etc.
    – David Walker
    Oct 29, 2017 at 3:49

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.