White Paper Template - Amazon S3



Technology White PaperTemplateVersion X.x ● DATE \@ "dd MMMM yyyy" 14 September 20175311050239007005 Polaris Way, Aliso Viejo-191452558928000, CA 92656? [Year] [Company Name] or a [Company Name] affiliate company. All rights reserved.[Company] [Address]?[Phone] [Fax] [Website]Trademarks[Product Name] are registered trademarks of [Company]. All other trademarks or registered trademarks are the property of their respective owners.DisclaimerThe information provided in this document is provided "as is" without warranty of any kind. [Company Name] disclaims all warranties, either express or implied, including the warranties of merchantability and fitness for a particular purpose. In no event shall [Company Name] be liable for any damages whatsoever including direct, indirect, incidental, consequential, loss of business profits or special damages, even if [Company Name] or its suppliers have been advised of the possibility of such damages.Document Lifetime[Company Name] may occasionally update online documentation between releases of the related software. Consequently, if this document was not downloaded recently, it may not contain the most up-to-date information. Please refer to [website].com for the most current information.From the Web site, you may also download and refresh this document if it has been updated, as indicated by a change in this date: [Date].Where to get help?[Company Name] support, product, and licensing information can be obtained as follows.?Product information — For documentation, release notes, software updates, or for information about [Company Name] products, licensing, and service, go to the [Company Name] website at:?.[website].comTechnical support — For technical support, go to .[website].com and select Support. On the Support page, you will see several options, including one for making a service request. Note that to open a service request, you must have a valid support agreement.Your comments?Your suggestions will help us continue to improve the accuracy, organization, and overall quality of the user publications. Please send your opinion of this document to:?Documentation@[Company Name].comIf you have issues, comments, or questions about specific information or procedures, please include the title and, if available, the part number, the revision, the page numbers, and any other details that will help us locate the subject that you are addressing.Table of Contents TOC \o "1-1" \h \z \u Executive Summary PAGEREF _Toc480208909 \h 5Introduction PAGEREF _Toc480208910 \h 7Challenge PAGEREF _Toc480208911 \h 8Solution PAGEREF _Toc480208912 \h 10Benefits PAGEREF _Toc480208913 \h 11Specifications PAGEREF _Toc480208914 \h 12Summary PAGEREF _Toc480208915 \h 13Learn More PAGEREF _Toc480208916 \h 15Appendix PAGEREF _Toc480208917 \h 16Sample Styles PAGEREF _Toc480208918 \h 17Document HistoryPaper copies are valid only on the day they are printed. Contact the author if you are in any doubt about the accuracy of this document.Revision HistoryThis document has been revised by:Revision NumberRevision DateSummary of ChangesAuthorv111-11-2020Updated chapter xTechnical Writerv211-11-2021Updated chapter xProject Managerv311-11-2022Updated chapter xTechnical WriterReference DocumentsPlease see the following documents for more information:Document NameVersionAuthorName of DocumentX.xAuthor NameName of DocumentX.xAuthor NameDistribution ListThis document has been distributed to:NamePositionCompanyActionFirst, Last NameIT ManagerCompany/ClientReviewFirst, Last NameBusiness AnalystCompany/ClientReviewFirst, Last NameDocumentation pany/ClientUpdateExecutive SummaryUse the Executive Summary to persuade the reader that the white paper is worth their attention. Read more about how to write an executive summary here. Tips:Write the executive summary after you have completed the white paper. Focus on the business benefits, not the technical features.Keep it under 2 pages. Structure of an Executive SummaryAudience – write the executive summary for those in a decision-making role, such as managers, buyers, architects, and others who will use the document to make recommendations based on what’s in the main document.Content – provide enough information in the executive summary for the reader to understand the purpose, problem, scope, technical approach, solution, methods, results, and recommendations.Standalone – write the executive summary so it can be read independently of the main document.Position in Document – The executive summary is include after the table of contents and before the introduction.Length – in general, the executive summary should be 5 – 10% of the main document.Writing TipsSummarize the key points of the main document.Write it after finishing the main document.Use words, phrases, and terms that your reader will understand.DoDescribe the high-level issues and trends in the industry (or market sector) that you are involved with. Include the recommendations or conclusions that you have made about this main subject matter.Provide a Customer Quote, if appropriate, “Enter a quote from the customer. Include their name, title and company. Enter text here. Enter text here. Enter text here. Enter text here. Enter text here. Enter text here. Enter text here. Enter text here.”Summarize your findings - including the conclusions that you have made. Putting the conclusion at the end of your white paper make senses, but you need to be careful as this section is often overlooked by the reader, many of whom won't read to the very end. Don’tDon’t rehash the introduction.Refer to figures or tables located elsewhere in the documentUse symbols, acronyms, or other terminologyMake statements you can’t substantiate.Additional Executive Writing Tips are here: Executive Summary Writing TipsHow to Write an Executive SummaryLong v Short Executive Summaries Video: How to Write an Executive Summary (That Wins More Business)Video: Executive Summaries for Business Plans (YouTube)Introduction[The Introduction is the start of the actual white paper. After you have introduced the main topic in the executive summary, and provided compelling reasons to encourage your reader to learn more, they’ll turn the page to learn more. The introduction is essentially the next level down from the executive summary. From here, you will introduce the challenges facing the industry, customers, sector etc, and then lead into your proposed solution, as well as outlining potential solutions.]Read: How to Create an Outline for Your White PaperIn this section, your goal is to: Orient the reader – don’t jump into the problem immediately. Instead, help the reader understand why you’ve chosen this topic, its background, and if this is part of a larger problem.Why are you discussing this topic? Help the reader understand why you are discussing this topic now. This helps them determine if they are interested in the topic, warms them up for what’s coming next.Introduce a fact, statistic, or research finding that puts things in context. Use the last paragraph to lead into the next chapter.Writing Tips:Introduce the problem, customer need or pain point. Grab your readers’ attention in the first sentence or two. Use data to support your claims.Indicate the objective(s) of the white paper, and what is included in subsequent chapters. Structure the white paper to help your audience follow your thought process and understand how the white paper is organized.ChallengeOutline the business challenge that your client was facing before you started this project. Provide specific details, refer to previous studies that may have been undertaken and statistical data where possible to add gravity to your claims. Use bullet lists to clarify points:Describe the first challenge.Describe the second challenge.Describe the third challenge.Continue to describe the challenges and the approach you undertook to resolve this. Try to think of your customers are prospective investors. In addition, investors are a very discriminating audience.ProblemSolutionIdentify problemDescribe the solution.Identify problemDescribe the solution.Identify problemDescribe the solution.In this section, we define the problem statement. Here are some questions you want to answer in the:What is the current market situation? This helps puts things in context for the reader.Why are companies and/or individuals struggling in this area? Give an example to pull the reader in.What specific problems, needs and/or pain points need the most urgent attention?What potential benefits will be realized if we resolve these problems, needs and/or pain points? Where possible, use storytelling techniques to create a narrative that emotionally engages with the reader. What data points support these questions?What models, frameworks, or methodologies will help the readers to understand this information?]Sample Paragraph TitleYour aim in this section is to provide the reader will objective information that helps them judge the relative merit of your solution, idea, or concept — and backing this up by introducing your team’s expertise and track record in similar projects. Your reader want real facts, i.e. that you can stand over. To maintain their attention and build trust, provide facts that are interesting, relevant, and true. Provide trustworthy evidence to substantiate your claims and increase your credibility. Meaningful testimonials and endorsements reinforce this.Solution Describe how the service, technology, or business model works. This is the heart of the white paper, and differs from the previous section in that here we detail specific aspects of the solution. Many readers will have skimmed over the earlier chapters and come straight to this section. For this reason, add charts, tables, diagrams, and illustrations to stop them from skimming and hold their attention. Cross-references to external supporting documents if required. Avoid product descriptions written by product managers, web designers, or marketing directors as these often contain assumptions (and IT acronyms) that are understood only by their peers. Write the section carefully echoing the problems, challenges, and issues raised in earlier sections of the white paper. Tips:Introduce the solution. Describe the product in plain English. Remember, your reader is typically coming from a business, marketing, or finance background.Describe the core components. How does each part address pain point etc.Use subcategories to help readers grasp different parts or functions of the solution. Use diagrams to support this. Subcategories help the reader follow your thought process and absorb the content.Describe the benefits of each of the part of the solutions, and how it affects your audience. Link your solution to different audience segments, thereby improving your content’s relevance.Provide context. Give real-world examples to support your solution(s). Consider examples targeted at different buyer personas.Tabularize data to help readers visualize your solution(s), e.g. performance improvements, cost reductions, customer support numbers. BenefitsDescribe the main benefits your solution offers. Identify areas such as ROI (return on investment), usability, adherence to international standards, and value-for money. After providing this preliminary information, get to the main issues. If you know that your readers are, for example, technology experts then don't try to teach them about the basics. They’ll just skip past these sections. Generalities and repetition drives such readers away. Instead, describe specific aspects that will ring true with your audience. Quotes for customers who have used your solution are always very helpful. It demonstrates that you have authority in this field and can back it up with an authentic reference. Don’t take this for granted—not all your competitors will be able to supply such endorsements.Quotes for customers who have used your solution are always very helpful. It demonstrates that you have authority in this field and can back it up with an authentic reference. Don’t take this for granted—not all your competitors will be able to supply such endorsements.BenefitsMeaningBenefit #1Link the business benefit to a specific featureBenefit #2Link the business benefit to a specific featureBenefit #3Link the business benefit to a specific featureTarget MarketOutline details of the target market your product or service has addressed. This section may not be applicable to all white papers. As mentioned before, an experienced business writer will guide his or her readers through the document and avoid confusing them with acronyms, convoluted sentences, and labyrinthine paragraphs. SpecificationsThis section depends on the nature of your white paper. For technology-related white papers, this may work – or a similar technical section – whereas for others it may not be required. Outline the technical specifications of the solution. This can include details of the operating system, development tools, programming languages, hardware, middleware, and other aspects of the core solution. Graphics illustrate the relationship between concepts, technologies, and systems. Continue to expand on the solution. Use charts, diagrams, and lists to illustrate the salient points and help the reader understand your product. Also, remember that fatigue will kick in after several pages of solid text, so use graphics, tables and charts serve to balance the reading, while also maintaining their interest in the subject. SummaryClose the paper with a concise summary of your main points. As many readers will skip the entire document and just read this section, you need to summarize here the main selling points about your solution. In the Summary section:Summarize the objectives of the white paper.Remind them of the problem statement(s), but don’t repeat verbatim text from earlier sections. Find a more interesting angle.Highlight the solution’s value to your reader.Link problems to features.Finish strong. Encourage the reader to take action whether this is to contact you, download data sheets, or sign up for a webinar. Finally, remember that your white paper is a type of sales document; it is not a technical manual. Once you have finished it, leave it aside for a few days. Then go back and read it. Ask yourself: would I buy this solution? Hopefully the answer is Yes. If not, don’t be too hard on yourself as it takes time to write a persuasive white paper.Instead, identify the areas you feel are weak and go about strengthening them. Soon, you’ll have a nice, sharp document that you can proudly stand over. Read: 10 Ways to Make B2B White Papers More Interesting3 Mistakes to Avoid When Writing White PapersChecklist for Writing White PapersGrow Your Business By Writing White PapersGuidelines for Writing White PapersHow Much Can You Charge For Writing a White Paper?How to Create an Outline for your White PaperHow To Make Money Writing White PapersHow to Make Your White Paper Title More InterestingHow to Write a White PaperOrigin of White PapersSEO Best Practices for White PapersUsing White Papers for Strategic AdvantageWhat are White Papers?White Paper TutorialsWhite Papers Persuasive Writing TechniquesWhite Papers: How to Write Better TitlesWhite Papers: Is there enough interest to justify writing it?Why White Papers Don’t Always WorkLearn MoreFor the latest information about our product and services, please see the following resources:Link to other white papersLink to case studiesLink to technical documentationConnect with usFacebook | LinkedIn | TwitterAddressName: Address: Address, City, Zip/Post Code, CountryEmail: email@Website: Tel: XXX-123-456-789Fax: XYZ-321-987-654This document defines the White Paper to be used for [name of company] projects.AppendixUse appendixes to provide information published separately for convenience in document maintenance (e.g., charts, classified data). As applicable, each appendix should be referenced in the main body of the document where the data would normally have been provided. Letter appendixes alphabetically (A, B, etc.).Identify the methodology to be used and the standards applied to the project, for instance, ANSI/IEEE Standard for Software User Documentation or the Software Engineering Institute’s SQA Key Process Area guidance, etc. Definitions, Acronyms and Abbreviations[Include the definitions of all terms, acronyms, and abbreviations required to properly interpret the White Paper. You can reference this information in the project's Glossary if necessary.]Enter definitions here.TermMeaningIdentify termProvide a brief definition.Identify termProvide a brief definition.Identify termProvide a brief definition.References[Outline all documents referenced in the White Paper. Identify each document by title, number (if applicable), date, and owner. Specify the sources, such as Subject Matter Experts, from which the references can be obtained. You can provide a reference to an appendix or to another document, if necessary.]The following documents may provide greater clarity on the White Paper as described in the following chapters.#Document TitleDoc #Version #Author1Documentation Plan X.x X.xDocument Owner2Software Development Plan X.x X.xDocument Owner3Configuration Management Plan X.x X.xDocument OwnerSample StylesHeading OneSample Body TextLorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam id leo suscipit lacus lobortis tempus nec et lacus. Curabitur tincidunt erat in lorem pretium, non finibus eros dictum. Proin eu imperdiet dolor, in pulvinar nulla. Sample Bullet listBullet ListBullet ListBullet ListHeading Two Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam id leo suscipit lacus lobortis tempus nec et lacus. Curabitur tincidunt erat in lorem pretium, non finibus eros dictum. Proin eu imperdiet dolor, in pulvinar nulla. [Start text here]List Number StyleList Number StyleList Number StyleHeading ThreeLorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam id leo suscipit lacus lobortis tempus nec et lacus. Curabitur tincidunt erat in lorem pretium, non finibus eros dictum. Proin eu imperdiet dolor, in pulvinar nulla. [Start text here]Numbered ListNumbered ListNumbered ListSamples TablesThree Column Table.Cell 1Cell 2Cell 3Cell bodyCell bodyCell bodyCell bodyCell bodyCell bodyTwo Column TableFor more information about using your MacBook Air, see the following:To learn aboutDo thisUsing this productSee Chapter 3, “Problem, Meet Solution,” on page 39.Using Life applicationsGo to the website at ilife. Or open an application, open Help for the application, and then type a question in the search field.Code SampleThis is a code samplepublic static void main(String[] args) { int radius = 0; System.out.println("Please enter radius of a circle"); try //if invalid value was entered catch(NumberFormatException ne) { System.out.println("Invalid radius value" + ne); System.exit(0); }Error MessageThis is an error message. WARNING: Failure to follow these safety instructions could result in fire, electric shock, or other injury or damage. Failure to follow these safety instructions could result in fire, electric shock, or other injury or damage.Warning MessageThis is a warning sampleWarning: Failure to follow these safety instructions could result in fire, electric shock, or other injury or damage. Failure to follow these safety instructions could result in fire, electric shock, or other injury or rmation MessageThis is an information sampleInformation: Failure to follow these safety instructions could result in fire, electric shock, or other injury or damage. Success MessageThis is a success message.Success: Failure to follow these safety instructions could result in fire, electric shock, or other injury or damage. Failure to follow these safety instructions could result in fire.Notification MessageThis is a notification.Notification: Failure to follow these safety instructions could result in fire, electric shock, or other injury or damage. NoteThis is a note.Note: ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download