TechComm Summer Classic: The User Guide (aka User Manual) provides the information and instructions needed to set up and use a product. A User Guide includes written and visual information (such as diagrams or screen shots) to assist the user in completing tasks associated with the product (or service), organized along functional or workflow lines.
TechComm Summer Classic: the phrase “structured writing” seems to demand something in the way of definition, not because its meanings are obscure, but because they are so varied. This is a product of diversity of interests, not lack of definition. My definition is a declaration of my interests; no more.
Join Adobe for their upcoming webinar on XML Documentation Add-on for Adobe Experience Manager
TechComm Summer Classic: The BRD synthesizes input from stakeholders and analysis of the current business situation to provide a technology-neutral description of what the product should do, rather than how it should do it.
TechComm Summer Classics: Agile’s iterative nature and focus on the self-directed team support writers’ attempts to expand their roles on project teams, improve the quality of their deliverables, and avoid most of the end-of-release-cycle crunch that typically results from a traditional waterfall process. No matter if your employer has joined the agile movement, or if you still work in a 20th-century waterfall world, or some hybrid of the two, you can recognize and learn to rise to the challenges common to most development teams.
TechComm Summer Classic: The FAQ (Frequently Asked/Answered Questions) delivers content to users/customers that addresses the most common information needs on using the products or services produced by the organization. Most often delivered via a website, the FAQ uses a Question and Answer format designed to be easily findable and quickly consumed.
Unfortunately you can’t simply push a button and magically migrate everything. Complex factors like content types, formats, locations, and more, present challenges, and opportunities. Develop your content migration strategy with these key notes in mind.
You’ve poured your soul into your resume and it’s a masterpiece. You’ve whisked the dust off your best interview clothes and slayed the hiring manager with your brilliance. And then…nothing. A great gaping maw of silence.