# Your approach to writing documentation for XML files?

**URL:** <https://forum.kirupa.com/t/your-approach-to-writing-documentation-for-xml-files/324827>\
**Category:** Uncategorized\
**Created:** [September 10, 2011, 8:28pm UTC](https://forum.kirupa.com/t/your-approach-to-writing-documentation-for-xml-files/324827 "2011-09-10T20:28:19Z")\
**Posts on this page:** 1\
**Page:** 1

<div class="post-metadata">

**Author:** ![flashgroove](https://avatars.discourse-cdn.com/v4/letter/f/b5e925/32.png) [@flashgroove](https://forum.kirupa.com/u/flashgroove)\
**Post date:** [September 10, 2011, 8:28pm UTC](https://forum.kirupa.com/t/your-approach-to-writing-documentation-for-xml-files/324827/1 "2011-09-10T20:28:19Z")

</div>

What is your approach to writing documentation explaining the options and use of XML files for a project ?

Do you write commented instructions directly in the XML file ?

Do you create a different text file in which you write instructions ?

Do you explain the use of blocks of XML or do you detail each element and it’s function ?

I am looking for some guidelines on how to write the documentation for large XML files that control the settings and content of projects.

Looking forward to your advices.