Technical Blogging Standards: Difference between revisions

From Open Source Ecology
Jump to navigation Jump to search
No edit summary
No edit summary
Line 14: Line 14:


For other work product - such as construction or fabrication results, or even organizational development  - blog posts can be written with the corresponding 6 pieces of content that are closest to the actual item - such as a video demonstration of a web platform instead of the ''Field Testing Video.''
For other work product - such as construction or fabrication results, or even organizational development  - blog posts can be written with the corresponding 6 pieces of content that are closest to the actual item - such as a video demonstration of a web platform instead of the ''Field Testing Video.''
=Rapid Blogging Guide=
Go to the [http://blog.opensourceecology.org/wp-login.php?redirect_to=http%3A%2F%2Fblog.opensourceecology.org%2Fwp-admin%2F&reauth=1 Open Source Ecology Blog Login Webpage] and fill out your username and password. For rapid registration help, contact opensourceecology@gmail.com
[[Category:Documentation]]
[[Category:Documentation]]

Revision as of 19:35, 14 August 2012

Technical Blogging Standards

See also Blogging Standards

The key deliverable that brought OSE to the world stage has been regular reporting of prototyping and progress results og GVCS development. The core deliverable of OSE is such documentation. Every blog showing a finished build + test cycle by active project developers should include several features listed here. The Soil Pulverizer Prototype II Blog Post is referenced in the descriptions below as a representative example of all the element.

  1. Status update and context regarding its importance: We have finished the second prototype of the open source soil pulverizer – an important labor-saving device for soil-handling in CEB construction. It is useful because it combines digging-pulverizing-loading the CEB press in one device...
  2. Fabrication video - This video should tell a story and be interesting and aesthetically appealing by including basic editing and a soundtrack. Fabrication footage should be taken at each single change of the fabrication process, so the viewer can see all the steps - which can be used to tell a story even without using a script. A script is useful for improving quality. A tripod or camera stand should be used to capture action footage. Example: notice how the Pulverizer video walks the viewer dynamically through all the steps and actions in an effort to keep the viewer's attention, while covering the process from start to finish.
  3. Product CAD - Show CAD, models, animations, embed 3D manipulable files (STL, Sketchup, etc) into blog post, and link to the source files. Example: Note the CAD of the Pulverizer in qCAD with a direct link to the file repository.
  4. Product Specifications - Shows specifications and performance data, focusing on OSE Specifications. Example: see the table of specifications shown.
  5. Basic discussion of economic significance - discuss why the performance to cost ratio is high. Example: Note that the author points out a $200 dedicated parts cost for the soil pulverizer, or a fraction of what one would pay for a commercial counterpart.
  6. Field Testing Video - It is useful to cap off a blog post with actual usage video. See video at end of post.
  7. Future Work - What needs to be done still?

For other work product - such as construction or fabrication results, or even organizational development - blog posts can be written with the corresponding 6 pieces of content that are closest to the actual item - such as a video demonstration of a web platform instead of the Field Testing Video.

Rapid Blogging Guide

Go to the Open Source Ecology Blog Login Webpage and fill out your username and password. For rapid registration help, contact opensourceecology@gmail.com