TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: manual vs white paper From:Marguerite <mkrupp128 -at- yahoo -dot- com> To:Gina Jones <gina -dot- techwriter -at- gmail -dot- com> Date:Tue, 25 Aug 2015 21:04:51 -0400
A lot depends on the length of the white paper.
If it runs more than 2-3pages, then an appendix might be best.
If you're stuck with having to include the white paper text as-is in-line, perhaps you could put it on a lightly shaded background to differentiate it from the rest of the text, as if it were an extended sidebar.
Marguerite
Sent from my iPhone
> On Aug 25, 2015, at 1:32 PM, Gina Jones <gina -dot- techwriter -at- gmail -dot- com> wrote:
>
> Hi all!
>
> I was recently sent a white paper as is, with instructions to insert the
> content as a new topic within the relevant chapter of a user manual I am
> working on.
>
> To maintain writing consistency and keep out pre-sale narrative, I'm going
> to suggest appending the white paper to the manual or including a
> cross-reference to the site it's published on. Is there an alternative to
> these options? Can you think of additional reasons or have any advice on
> persuading my client to go this route?
>
> Thanks,
>
> Gina
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Learn more about Adobe Technical Communication Suite (2015 Release) | http://bit.ly/1FR7zNW
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as mkrupp128 -at- yahoo -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwhirl.com/email-discussion-groups/ for more resources and info.
>
> Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com
>
> Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Learn more about Adobe Technical Communication Suite (2015 Release) | http://bit.ly/1FR7zNW
