Wiki feature documentation

From RPM Wiki

Development

[edit]

Summary

This page gives an overview of how RPM features and functionality are documented in this wiki.

[edit]

Pages

Any given feature will have several pages of information. A typical feature may have pages like this:

  • "Feature"
    • Category: Reference
    • Public
    • A guide primarily for RPM users
  • "Feature (spec)"
    • Category: Functional spec
    • Public
    • The design document describing a feature
  • "Feature (technical)"
    • Category: Technical spec
    • Restricted
    • The technical "blueprint" for developers. This is restricted from the public more to keep it out of help searches than for IP security.
  • "Feature examples"
    • Category: Testing
    • Public
    • Some real-world walk-through of how the feature should work
  • "Feature testing"
    • Category: Testing
    • Restricted
    • How to test the feature. This is restricted from the public more to keep it out of help searches than for IP security.

This is only a guideline, not a rule. An advantage of a wiki is it's very easy to add more detail when its warranted. In some cases an entire page may be dedicated to one aspect of a feature or one part of a set of testing documents for a feature. Just make sure to put in lots of internal links among related pages.

[edit]

Spec page contents

  • Summary
  • Examples
  • Details
  • Security
  • Future
  • History
Retrieved from "http://www.rpmsoftware.com/wiki/index.php/Wiki_feature_documentation"
  • This page was last modified 20:33, 24 Jun 2008.
  • This page has been accessed 708 times.