How do I generate documentation for a project?

Wordpress project documentation: how to streamline new developers integration into complex Wordpress project?

• We have the team working on development and support rather complex websites combination on Wordpress MU. Now we find increasingly difficult to integrate new developer into project - particularly for support of completed modules. Is there any formal framework or practice for creating developer's documentation for such a project, which can simplify and accelerate familiarization with it? Thanks.

• Answer:

  With any development project, the best thing you can do is documentation and clean code. Clean code: Following a coding standard, making sure that every file looks and feels the same to the developer.  This includes good spacing, comments, and breaking functionality out into logical chunks (functions/methods) Following a naming standard for variables, functions, classes, methods, and files Documentation can and should come in two forms: In code comments that accurately explain what is going on in each file and at each main step through the code Outside the code documentation that explains the overall view of each main component, what it does, and how it interacts with the rest of the system. There will always be a learning curve with new people. It's the reality of the world, but you can alleviate most of it by having consistent dedication to clean code and documentation.