- Created by David Sinicrope, last modified by William Lupton on Mar 18, 2025
Project status:
- Paper initiation draft
- Paper complete
Topics from the right | Authors/Editors |
---|---|
Top Level Messaging for the project/project stream |
|
next steps:
| |
Introduction | This short paper is relates to (what is it) ... The resulting work will enable.... The potential impact of the work is |
etc. | |
etc. | |
Summary, Call to action | Links, etc. |
Status/Approval
Version | Version editor | Project Status | Changes in this version | Wiki page version |
---|---|---|---|---|
original is .01 1.0 is first approved version | e.g. original , member notification, draft approved, update, straw ballot, final ballot, published work, etc | required for approved and ballot versions |
For papers requiring ToC use this
Table of Contents
Figures | Link |
---|---|
Open Broadband Continuous Integration | Figure 1 |
Executive Summary
This document addresses
Introduction to
Open
What it makes possible
The ...
The value of xx to stakeholders
- Service providers
- Integrators
- Opportunity to
- Suppliers
- Development of ...
Considerations (as a starting point)
The following considerations dictate the style of the deliverable being created. The term "white paper" implies a set of text and diagrams the may be published in various forms papers, articles, briefings, web pages, etc.
Is there a top level of positioning & messaging for the project?
- If not complete the section on the left
Deliverable examples document/paper/page types:
- New Project briefing - coincides with approval of BBF project
- Positioning paper
- Educational Paper- helps reader understand technical work
- Best practices paper. - provides implementation guidance
- Use Case or application note
- Presentation
Structure, Length
- There probably is no right structure with a couple of exceptions
- Introduction must be clear and motivate the reader:
- what is the paper about. and why are we writing it?
- If it's about technical work then, what is it why is it, what does it do, what's the impact, how many does it impact and what is the business value of the work to stakeholders?
- Body of the document
- Dependent on the paper
- Informative papers should be specific and with use case examples that are realizable
- Genral information about the problems that need addressing without a proposed solution are generally of little value and may just irritated the reader who knows about the problems and is reading to find a solution.
- Length
- Dependent on the paper type but the shorter the better. If the paper has good detailed technical information or multiple use case then longer papers may be justified
- Briefings are likely a single web page / 3-500 words
- summary
- return to the importance how the work could make a difference for the reader and their organization
- return to reason why we wrote it and there must be a recommended call to action and expected outcome
Unless this is something
Language, Respect
- This is declared to be an acronym-free zone.
- there was one diagram shown recently that had 14 unexplained acronyms
- Only if a term is used more than once may the construct Xxxxxx Yyy Zzz(XYZ) be used. Use of unexplained acroynms, is arrogant, and the fastest way to stop the understanding of a piece
- Avoid pontification with supposedly insightful wisdom, People want facts and actions
Purpose of paper
- What is it?
- who does it help?
- Why is it impactful?
Technical Papers
- Use cases for the work etc
- Project description
- Timeline
- Getting people to participate at the BBF
Positioning papers
- Why the BBF is doing the work?
Network diagram or graphic
Audience
Publication type
- Web Page
- Article
- Posted white paper
- Social media
Format
- Toc?
- Length
- 1 page, 3-4 pages. 6-8 pages
- The whole traditional BBF format does not work for short papers
Delivery and promotion
- Consider infographs, blogs, articles, web pages,mixed media, video delivery perhaps called videopapers), not just PDFs