Sunday, August 25, 2024

Writing with acrylic fingernail clicks on the keyboard...

 Technical Writing 101: A Real World Guide to Planning and Writing Technical Content

3rd Edition covers Web 2.0 and DITA
by Alan S. Pringle and Sarah S. O'Keefe
Copyright 2000-2009 Scriptorium Publishing Services, Inc.

I intend to reference this for technical writing later but found some of these snippets interesting, informative, or otherwise useful knowledge. These are snippets from the above mentioned reference and within the text, it provides obsolete information or writing processes that is explained on the website from the publisher. This is such a good read (so difficult to make relatable/daily conversational vocabulary work in a technological document), I highly recommend for the budding IT enthusiast!

Technical Writing Snippet by Scriptorium Publishing, Inc.

Snippet from Technical Writing by Scriptorium Publishing, Inc.

Snippet3 from scriptorium publishing, inc.

What I found in the pdf:

Snippet from www.scriptorium.com/singlesourcing.pdf

Snippet4

This last tidbit of advice has me at an advantageous point if this practice isn't configured into a programming style of doing documentation now. With placeholders, HTML, ASP.NET, and other tools for web developers, why can't this be programmed? We have the same data but need to update/maintain its integrity... can this not be planned?

Or is this a new type of IT Documentation in the future?

Note: Hence the title, there was much cut and paste action in this post!

_Mischief


No comments:

Post a Comment

Thank You For Commenting!

Welcome to Gravacity!

Welcome to Gravacity! I have been anticipating my C#-Part 2 NWTC course in the second term of the Fall Semester and within it, a game I must...