SharePoint developer documentation
I will need to write pretty complete documentation for an upcoming project and I was wondering if anyone has some good documentation samples for SharePoint solutions.
eg. What should be done in the documentation for:
- custom site definition
- function
- custom web part
- custom workflow
- etc. etc.
Any samples there would be great. I have a good idea of what things to include, but it would be interesting to see some best practices.
source to share
It is important to capture the business reason why these things came up in the first place. Including the original requirements in the documentation provides context, especially for understanding which function was intended to help plan your requirements for the future. It's also a useful reference when a client suddenly wants a function to do something it was never intended to do.
Another useful thing to write down is dependencies . This is especially true when the developed artifact can appear in different places, for example, in the XML file of the description of the properties or the site, as well as in the page layout.
source to share