Stormwater Management Model (SWMM) Information for watershed water quality, hydrology and hydraulics modelers (Note this Blog is not associated with the EPA). You will find Blog Posts and Twitter Embeds on the Subjects of SWMM5, InfoSWMM, InfoSewer, SWMMLive, InfoSWMM SUSTAIN, SWMM4 and SWMM in general.
Subscribe to this blog
Follow by Email
#RTFM and WTFM How to write a fine modeling manual worth reading (ideas)
Note: The following is copied in part from this blog
Once you've determined the scope, and who you're writing to, there are several different kinds of documents that you can write for them. Anne Gentle categorizes them like this:
Like the Getting Started document I mentioned previously, this is the place where you tell users what they need to know before they even get started.
The reference guide is comprehensive and usually pretty dry. This is where terms are defined, functions' input and output are explained, and examples are given. The tone is factual and to the point. There's not much discussion, or conversation. The voice is usually impersonal.
Tutorials hold your hand and lead you down the path. They show you each step, and occasionally sit down on a bench by the path to explain the rationale for a particular step. They are very conversational, sometimes even chatty. The voice is personal; you are speaking to a particular person, defined in the earlier persona phase.
Often linked to from the tutorials, the learning/understanding documents dig deeper. They investigate the why and the how of a particular thing. Why was a certain decision made? How was it implemented in the code? What does the future look like for this thing? How can you help create that future? These documents are sometimes better done as blog posts than as part of the formal documentation, as they can be a serious distraction to people that are just trying to solve a problem.
There's a reason that the Cookbooks are often the best selling part of the O'Reilly technical book catalog. People want solutions, and they want them now. The recipe, or cookbook section of your document, should provide cut-and-paste best-practice solutions to common problems. They should be accompanied by an explanation, but you should understand that most of the cookbook users will cut and paste the solution, and that'll be the end of it for them.
A large part of your audience only cares about solving their immediate problem, because that's all they're getting paid to do, and you need to understand that this is a perfectly legitimate need. When you assemble your new Ikea desk, you don't care why a particular screw size was selected, you just want the instructions, and you expect them to work.
So it's critical that examples have been tested. No matter how trivial an example is, you must test it and make sure it does the expected thing. Many frustrating hours have been spent trying to figure out why an example in the docs doesn't work, when a few minutes of testing would have revealed that a colon should have been a semicolon.
Recipes should also promote the best practice, not merely the simplest or fastest solution. And never tell them how not to do it, because they'll just cut and paste that, and then be in a worse fix than when they started.
One of my favorite websites is There, I Fixed It, which showcases the ingenuity of people who solve problems without giving much thought to the possible ramifications of their solution—they just want to solve the problem.
Yes, error messages are documentation, too. Helpful error messages that actually point to the solution save countless hours of hunting and frustration.
Comment: A really nice water analogy for the field properties Divergence, Curl and Gradient from the Blog Starts With a Bang
....it's pretty mathematically intensive, but what's missing from most textbooks and E&M courses are physical explanations of what the mathematics means. For instance, I've started teaching about fields, and pretty much every textbook out there goes on and on about the properties of fields. They say you can do three things to fields, take the gradient, divergence, orcurl of them. (Are you asleep yet? I'm sorry!) What do these things mean? An easy way to picture it is in terms of water. If you placed a drop of water anywhere on, say,Earth, the magnitude and direction of how it rolls down is the gradient of the Earth's elevation. If you let that drop of water flow, as it goes downhill, it can either spread out or converge to a narrower stream. When we quantify that, that's what the divergence of the field is. And finally, when that water is …
Soffit Level (pipe technology)The top point of the inside open section of a pipe or box conduit. The soffit is the highest point of the internal surface of a pipe or culvert at any cross-section. The soffit is also referred to as the pipe obvert. So it is not quite the Crown of the Pipe. Here is an image I found that hopefully explains it better.
Engine Error NumberDescription ERROR 101: memory allocation error. ERROR 103: cannot solve KW equations for Link ERROR 105: cannot open ODE solver. ERROR 107: cannot compute a valid time step. ERROR 108: ambiguous outlet ID name for Subcatchment