Blogs about: Software Documentation
Featured Blog
Project Time Estimates
How do you estimate the time needed to write a document? As an example, let’s talk about the user manual, a type of document that is long, complex and typically rather tricky to finish on time a… more →
LexPower
Project Time Estimates
lexpower wrote 2 months ago: How do you estimate the time needed to write a document? As an example, let’s talk about the u … more →
Software Librarians
— 6 comments
davidlongstreet wrote 3 months ago: There is a job title in the software domain called software librarian. I searched for the job title … more →
Visualize It
lexpower wrote 3 months ago: When you have trouble writing about something, try to visualize it. Create a mental image of the thi … more →
Benefits to documentation (yes there are some)
davidlongstreet wrote 3 months ago: When application documentation is given meaningful names and numbers, it can be found easily. Softwa … more →
Revisions: Content Editing
lexpower wrote 3 months ago: The key to handling revisions is how well you planned and structured the document, and how you handl … more →
LexTips: Make It Interesting
lexpower wrote 4 months ago: Develop the “story” of your document to keep readers interested: Follow your outline (so … more →
Is documentation still relevant?
— 1 comment
davidlongstreet wrote 4 months ago: There was a great question posted on linkedin by Danielle Vokski. Her question was, “Do you t … more →
Just Google it! Huh?
— 2 comments
davidlongstreet wrote 5 months ago: There is a misconception it is okay to have documentation scattered about individual computers and a … more →
Evaluate Your Writing: Formatting
lexpower wrote 5 months ago: When you evaluate your document, ask yourself if its appearance helps your customers easily learn wh … more →
Evaluate Your Writing: Content
lexpower wrote 6 months ago: If the content of your documents is not accurate and complete, how are your company’s customer … more →
Evaluate Your Writing: Planning and Organization
lexpower wrote 6 months ago: Evaluate your writing to help control the process of creating a document and to ensure that the fina … more →
Organization makes a system of many appear fewer
davidlongstreet wrote 6 months ago: Mark Twain once said, “A person that does not read books is no better off than a person who does not … more →
The code is not the documentation!
— 1 comment
davidlongstreet wrote 6 months ago: There are a lot of reason why the code can’t be the documentation. The first reason is obviou … more →
Brunelleschi's Dome
davidlongstreet wrote 6 months ago: In the late 1200’s it was decided that Florence needed a cathedral that would rival the cathedrals o … more →
Software documentation
thiagoferreira wrote 6 months ago: The idea of this post is to talk about the software documentation and its importance as well. Just t … more →
Welcome to Club Chaos!
— 1 comment
davidlongstreet wrote 6 months ago: The secret of all victory lies in the organization of the non-obvious. - Marcus Aurelius (Roman Empe … more →
Polish Your Writing with Style, Part 2
lexpower wrote 6 months ago: In the previous article, I introduced several elements of style for your consideration. This article … more →
What If You Have More Than One Audience?
lexpower wrote 7 months ago: If you have more than one audience, there are several ways to handle this situation. Using a softwar … more →
LexTips: Accuracy in Writing
lexpower wrote 8 months ago: Make the content of your document as true and accurate as possible. This means you must know your su … more →
