OSE Instructional Guidelines

From Open Source Ecology
Jump to: navigation, search

The key principle for OSE instructionals is:

Create instructionals at the module level, not at the machine level. This way, we can document builds by reusing module instructionals.

OSE already does it in some way, and the need for this emerges clearly as the number of products that we document grows. We can reuse an entire instructional - and then make a small modification to it - to create a new instructional.

The second OSE principle is:

Document build complexity by numbering steps from 1 to the end - continuing the sequence so that the number of steps is a direct hint at build time and effort - as discussed at Build Ergonomics.