--- a/src/create-module.py Fri Jun 01 17:10:36 2012 -0700
+++ b/src/create-module.py Mon Jun 04 07:21:37 2012 -0700
@@ -230,11 +230,13 @@
The source code for the new module lives in the directory ``src/%(MODULE)s``.
+Add here a basic description of what is being modeled.
+
Design
======
-Add here an overall description of the software design and how it fits
-into the existing ns-3 architecture.
+Briefly describe the software design of the model and how it fits into
+the existing ns-3 architecture.
Scope and Limitations
=====================
@@ -252,17 +254,30 @@
*****
This section is principally concerned with the usage of your model, using
-the public API.
+the public API. Focus first on most common usage patterns, then go
+into more advanced topics.
Building New Module
===================
-Include this section if there are special build instructions.
+Include this subsection only if there are special build instructions or
+platform limitations.
+
+Helpers
+=======
-Helper
+What helper API will users typically use? Describe it here.
+
+Attributes
+==========
+
+What classes hold attributes, and what are the key ones worth mentioning?
+
+Output
======
-What helper API will users typically use? Describe it here.
+What kind of data does the model generate? What are the key trace
+sources? What kind of logging output can be enabled?
Advanced Usage
==============
@@ -275,6 +290,11 @@
What examples using this new code are available? Describe them here.
+Troubleshooting
+===============
+
+Add any tips for avoiding pitfalls, etc.
+
Validation
**********