Skip to content

Pro Bono: OSS Content Creation Steps for White Paper, Case Study, e Book...

Ryan St. James edited this page Aug 5, 2019 · 2 revisions

Using Lars' White Paper 2019 as an example on how to, recommended steps:

Twitter

Brainstorming together before write-ups:

The MP Community tackles

If a MicroProfiler offers to write a White Paper, Case Study, e-Book... etc

  • Have she/he sent a written message to the Email?
  • Have she/he added/discussed in the Zoom call such desire?
  • Have the MP Community asked questions about the potential value of that content?

Analyzing the Value of Content

  • Does the creation of content adds value to MicroProfile developers & users, today & scales short & long term?

If YES: avoid vacuum actions

A few steps:

Content Creation

  • Write the gitIssue
  • Use the MP drive under Content Folder &/OR
  • Use PRs to enable MicroProfilers' technical reviews to be optimal before placing draft to the drive
  • if stuck, use the git & forum

Copy/Edit review: Writer and MicroProfilers provide a set window timeline for proper feedback

First:

  • drop the word version to the drive
  • if document is large, timeframe to enable feedback loop needs to be also larger and be stated clearly via the forum by author
  • reviewers will use "suggestive mode" for all feedback
  • comments are valuable but only when write-ups are not possible. Avoid commenting if that is not the case.
  • Writer accepts or declines feedback
  • document versions are kept under the Archived folder as progressed is made

Design: feedback loop has ended and document is perfected

  • Writer believes that document is ready for design step
  • git is used to state that & further update on future work
  • whomever designer is able and ready to jump to the project- goes for it
  • the designer transform the word document to PDF to enable feedback via that tool
  • design folder is created
  • created by the writer-- designs, pics, graphs etc are dropped in the design folder
  • writer states the minimum graphs needed aside from those she/he created
  • copyright & not known stuff is stated clearly via the git issue
  • usually 3 people are working together at this point, example: Writer (Lars), Designer (Ryan) & Broker (Amelia)
  • many iterations will be owned creating newest documents, using PDF collaboration
  • broker owns follow ups with designer via git and if needed via video calls- show and tell. the writer is welcomed to attend, if possible
  • broker approves final draft

MP Website: Designer & Broker

  • Document will be added either to main page &/or resources page

Media Push: writer, designer & broker

Using git issue:

  • creation of design media minimum requirements are set
  • write up of twitter description
  • publish date set, original design for just that publication
  • published tweet is sent to MP Forum to formally announce the completion of the project

Steps after Publication:

Adjustments of content

  • a excel sheet is created with public edit access
  • writer tracks feedback likely incoming via public & private mediums
  • ~ once per week, if needed- document is adjusted by designer (whenever is available)

Media Push

  • is there a need to schedule weekly/monthly pushes of the content?
  1. if yes: Broker & Design set it up and check metrics to see if action is valuable (3 months testing)