Tuesday, May 29, 2012

Part 3 - What is a component Documentable?

A component is documentable because you need other developers consume, use or produce new parts of the component these developers need to know how the component works and how they can use the component.

The process of documentation starts at the begging of the component's development when you are designing the artifact. The first part of the documentation is the Analysis of the component the second parts are the technical documentation that you wrote in the development phase.

You need the documentation for the following reason:

  1. You need others extends your component.
  2. You need other use your component.

To warranty that your component would be used and deployed with safety you need to do a good documentation process. 

No comments:

Post a Comment

Revolutionizing Stream Pipelines with Custom Intermediate Operations JEP 473: Stream Gatherers (Second Preview)

Introduction In the ever-evolving scene of Java improvement, the Stream API has been a foundation of utilitarian programming paradigms sin...