Tag Info

New answers tagged


I've written manuals under a Scrum process, so I'll describe what worked for my team. I'm going to treat your task as if you're writing a new book. From your description, you'd be replacing the vast majority of the content anyway, so better to think of it as a new book (for which you might be able to take advantage of the occasional previously-written bit) ...


Title: Meaningful but not overly long Rendering 1500 Users Helpless: An IT Project Report Abstract: Summarize the report in one paragraph Problem. Management Fix. IT Implementation. User Reception. Coverup. Sec. 1, Introduction: Give background on the project. (What led to it?) The recent release of Win8 with its BadIphone interface has ...


Chose the right title -- it's the hardest part in writing. Explain your targets and goals. Explain what do you wish in the future based on this.


Im tempted with The true and false of Boolean Variables... There is nothing !true about this. When you can't tell your true from your not-so-false The universal !false!


Depends on how formal or informal the technical writing is and whether the target audience is beginner's or advanced. A more specific and accurate chapter would be ideal. "Ins and Outs" is too vague.


An informal, jokey title is perfectly appropriate. This is especially true if, as I surmise, you're writing a progrmming manual of some sort. Computer science is a pretty informal field, after all. It's almost expected. The title isn't very eye-catching, but it's a common enough turn of phrase and there's nothing wrong with it, as such.


It's not that it's unsuitable, but the word play of "Ins and Outs" isn't very well matched with the subject of "Boolean Variables." "Ins and Outs" sounds like it's more about GPIO pins. I'd be tempted to do something like; "If This_Chapter == About_Boolean_Variables {Read}" ;)


In order of descending utility, IMO: Project/feature/bug tracking software, for well-defined product changes. A must. Email notification to other writers (broadcast) that refers to entries in #1 or to a wiki entry describing the doc change. The email summarizes the context & change enough that other writers can tell whether it affects them. The wiki ...

Top 50 recent answers are included