Documentation approaches

There are three main approaches to documenting JavaScript code, none of which are a one-size-fits-all solution. You will need to determine which approach makes the most sense for you and your team on the basis of your team size and the ambitions of your project.

The three main approaches can be referred to as the non-documentation, simple documentation, and robust documentation approaches.

In general, the larger your team is, and the larger the organization to which this team belongs is, the more likely are you to want robust documentation, although size isn't the only factor to consider here. Other factors include your team members' desire for external documentation and whether or not any of your code is customer-facing (for instance, if you offer a public API for your customers to extend your application).

..................Content has been hidden....................

You can't read the all page of ebook, please click here login for view all page.
Reset
3.144.89.238