For years, I've written documentation using ReStructured Text (RST). It's just one of several "lightweight markup languages ". For others, look at Markdown , StructuredText , Setext , among many others.
I generally use the rst2html utility that comes with Docutils . It works fine for small things.
I just read about the Sphinx documentation …
more ...Check out Carol Johnson's book The Language of Work: Technical Communication at Lukens Steel, 1810 to 1925 . It puts technical writing in a bigger perspective.
The cool thing is dragging meaning out of a corpus of documents.
more ...December 11th, the electric power went out here in the northeast, and stayed out until late on the 14th.
We have gas heat, gas cooking. But the furnace wouldn't run without AC power. So, I now have a favorite electrical appliance -- the blower on my furnace.:Apple-tab-span:``
Here's my strategy …
more ...See Configuration Options in Code or INI Files? . Also, see Python as Configuration Language .
Here's some of the argument.
Check out this StackOverflow "question": Does anyone have metrics on the utility of formal Unit Testing? . While -- technically -- it does have a question, it's more of a rant against formal unit testing than a proper question.
Here's the conflation comment. "I've worked with developers who never caught any errors in …
more ...No one wants to be Rickrolled. I suppose it could have been funny, once, for about 15 minutes. I didn't think it was all that funny to begin with, but there it is -- a part of the lexicon. However, it remains obscure, and sometimes hard to explain to non-technical folks …
more ...The Open Source Enterprise article in the November 15th InformationWeek is quite cool. Here's the "wow" quote for me.
Another way that open source code meets current needs is through lighter-weight integration than commercial vendors typically offer. By definition, open source code adheres to publicly approved standards. That means open …more ...
See this question on Python objects deleting themselves . There was some fundamental confusion about objects, deletion and garbage collection.
Some additional material was posted in an answer (not in the question, where it belongs) making it a little hard to go from question to answers. The original poster's non-answer had …
more ...There's this huge gulf between "protecting" our intellectual property (IP) and making money off our intellectual property. In our case, we have experts creating business models that we embody in some source code as business rules.
What's the IP? The software or the model? Where's the value? Is it out …
more ...