They are easily printable and are available in all possible formats. Towards the top it will list out the topics with different sub sections. To achieve them, plenty of documentation types exist. Enter the name, logo and URL of your product and other settings like the primary color of the generated site. There is a tree like structure that is provided by this document. Waterfall teams strive to create detailed documentation before any of the engineering stages begin. There are different points as well as instructions that are covered in the guide that is offered by them. Originally published at AltexSoft’s blog: “Software Documentation Types and Best Practices”.

You can prepare this template either on an excel sheet or an MS word document.

Other companies may follower a more evolutionary path which uses wireframes as the skeletons for mockups. However, their categories may also differ. Source: Wireframes vs. Prototypes vs. Mockups. Josh Porter, former Director of UX at HubSpot, believes in a leaner workflow where you jump straight from sketching to prototyping (and skipping wireframing altogether). Hope this post will help the users to build a better documentation and help guide for their site. This above-shown project process documentation template deals with how a project is supposed to proceed.


Because you want your product to be the right one (regardless of iterations), low fidelity prototypes created in an online app may be uglier but can help you iterate quicker versus a coded or high fidelity prototype.

User documentation covers manuals that are mainly prepared for end-users of the product and system administrators. The navigation of your help site reflects the folder structure on Google Drive. With Startup App and Slides App you can build unlimited websites using the online website editor which includes ready-made designed and coded elements, templates and themes. Discuss and form a consensus with stakeholders regarding what needs to be covered in the architecture design document before it has been created and use a defined template to map architectural solutions. Depending on your process, detailed mockups can either be the highest fidelity wireframes or the next iteration of concept mockups. .

… Product Design Process & Documentation Essentials (Part 1) Design Chris Bank • October 10, 2014 • 6 minutes READ . unit tests may be performed either by the QA team or by engineers).

All Rights Reserved. If you are planning to build one such documentation for your website than this can be achieved easily through WordPress.
Find My Documents Suggest a resource. Just enter the desired info into the footer or feel free to delete the footer if you do not need it. Online end-user documentation should include the following sections: In order to provide the best service for end-users, you should collect your customer feedback continuously.