Thursday, December 18, 2014

Short Note and Starting A Technical Writing Syle

Team. Upon tracking the page views for this weblog, it was found that some international visitors were visiting once or twice and then not returning. For fear that the style of English-writing which is being used might be somewhat confusing for those whose mother tongue is not English, we will adopt a simple style consistent with writing procedures and technical manuals. The style used so far is simply the most comfortable for the author.

The style of this paragraph was used to write a paper for COMPSAC 2005, an international software engineering conference. The paper was well-accepted. In the upcoming weeks, we will summarize the notes from previous posts with this style. The sentences will be shorter. Plus, the English will be simpler.

The delivery of the edited (redacted) source code for CABOOSE might be delayed. The source should be proof-read at least three times before delivery. Plus, the comments should be descriptive and meaningful. This will be about a sixteen hour effort. Planning allows for an hour of work each week day plus eight on the weekend. To begin evolving the prototype in the initial development cycle without reviewing the source at least three times would be unwise.

Also, we probably will add some more time on the project plan for the prototype. This is so we can create stencil handlers to use SOAP, REST, Hibernate, and etc.

We would appreciate any constructive critiques in the online forum at http://java.net/projects/caboose. La-La.

No comments:

Post a Comment