Recently I came across with this question, “What all documents required for proper knowledge transfer of any Drupal Project"?
As usual I went to search on drupal.org but failed to find any document list so I started making it on my own.
So here is the list:
-
Information about Infrastructure: Server/Environmental Details (Dev/QA/Prod/)
-
Details of LAMP/WAMP Installations: Detailed info about Web server/DB/PHP
-
Other Application used on Servers: In case of Cache Server/Media server.
-
Details of Database server & Understanding of database structure: In case of cluster db servers, Details for Master, Slave db & replica db. In case of mixed storage engine list of table under specific particular storage engines.
-
Web/DB Server Topology: Details of web server / db server/ load balancer server etc.
-
Drupal Core Version.
-
Details of mulit site / sub sites /groups etc.
-
List of Contributed Modules & Themes.
-
List of Custom Modules & Themes,
-
Documentation on code changes made in Custom module /theme: Detailed study of contributed module and themes and requirement understanding with the help of High level diagrams
-
Details of PATCH applied on Contributed modules.
-
Details about External Services: If any external service is involved in application like Flicker/You Tube / Face book/Twitter etc.
-
List of Content Types & their Usages.
-
List of Views & their Usages.
-
Details of Web form/panels/cck forms/Custom blocks/Pages etc.
-
Pending/New Change Requests.
-
Detailed Bug list of open bugs.
-
Details of open issues posted on Drupal.org/ forums for resolution (URLs).
-
Details of versioning system used (CVS, SVN, Git etc.)
-
Details of user roles and permissions (custom roles created - if any)
-
List and details of client side technologies used in custom code - JavaScript, jQuery, Bootstrap, AngularJS, NodeJS(although this is server side)
-
Details of internal defect tracking tool used (Zendesk, Jira, Bugzilla etc.)
My Original post : http://umarani.com/knowledge-transfer-documents-typical-drupal-project
Comments
Thanks!!
This is a great list - very thorough :)
Thanks for putting this up for us all to use Chintan!!
Thanks for sharing
Thanks for sharing the detailed documentation. I am sure, it is going to help all of us a lot.
Surendra Mohan
Drupal Consultant | Architect | Author | Trainer | Blogger
http://www.surendramohan.info/
thanks
Thanks for penning down this list Chintan
Sree