Open

Overview

This lesson will be focused on the documentation at Wayfast and how this is generated automatically for all the elements that we created within our project.

How to generate documentation in Wayfast?

Let’s navigate to “Project Execution” icon at top menu and click on “Project Documentation” tab. At this point, we don’t need any active requirement to work on this matter.

Open

We can only see the “Generate PDF” button, this is the unique option available on this page. Once we click on the button, a new tab is going to be displayed in the browser:

This PDF document is a detailed extract of all the objects created in our project and database. We can find different sections where we can analyze all the pages and their corresponding controls, actions and datasets. Also we can verify the requirements associated to the project with their statuses. And finally we can see the elements associated to our database (views, tables, functions, stored procedures, etc.).

Recap

Writing documentation improves the design of your code. It’s an important part of the project that sometimes is relegated in terms of timelines and task’s execution. This feature will bring a detailed extract to analyze the code structure and define new actions to take and also an easy way to audit what are the strengths and weakness of our code.