How to turn your research paper or article into a project documentation

Our goal is to enable engineers to learn about technologies to help them innovate. Each Month the content shared on our channels reach over 6 Million professional engineers & engineering students. Share your research as project documentation on Wevolver and get direct access to that community.

Why share?

‘You’ve put eighteen months or two years of your life into doing the research in your article. You’ve devoted months more to writing the paper and sending it to journals, dealing with comments, doing rewrites and hacking through the publishing process. Why would you not spend the extra couple of hours needed now to pull out from your journal article the key bits needed for a good project documentation and tap into a large engineering audience?’

What is the impact?

This all depends how well written the project documentation is, and how good the visuals are. But, in general, a post shared on our channels gets an average of 75.000 impressions. Remember, your project documentation is linked to all your social media channels, as well as your unique profile that can link to any website you want.

Dissemination of your work

What do I share?

You write your project documentation after you’ve finished and published your journal article — it is just a more readable and hopefully more popular version of that article, with key information summarized in about 500 – 1000 words. The key to good project documentation is state clearly what the developed technology is, what it does, and why it’s been created. You can skip the methodology and literature review section entirely.

A typical project documentation is constructed like this:

  1. Visuals (images and/or video’s
  2. Factual description of the technology
  3. Specifications (dimensions, components, materials, etc)
  4. References (to external sources with more info + your paper)
  5. Questions & feedback section where you can interact with the community

Here is an example of the project documentation of the Open Source Leg by the University of Michigan Robotics Institute.

Your project documentation on desktop & mobile.

How much time does it take?

Some researchers think that publishing project documentation takes the same time and hassle involved in submitting to journals, trekking through box after box of electronic publishing bureaucracy, and then waiting weeks or months before seeing a proof, and months more for publication. But publishing your project documentation on Wevolver is not like that at all. You simply add your documentation via our template. Converting your paper into a project on average takes about 60/90 minutes.

What happens after I share the project documentation ?

  1. You submit
  2. Wevolver’s editors review
  3. Editors message you;
    a. the project documentation is approved and scheduled for publishing,
    b. or there are adjustments recommended before the content can be published.

Usually you will receive a message within 24 hours. Once approved we aim to publish your work as soon as possible.

If we’re both satisfied with the project documentation , we’ll share the visuals (image or video) on our social media channels and link those to the project documentation on Wevolver.com

How about citations?

The project documentation may well not be cited itself — but if not, this is because its job is different. Academically, project documentation boosts citations for the core article itself. It advertises your journal article in ways that can get it far more widely read than just pushing the article out into the ether to sink or swim on its own. A post on our social media channels reaches other researchers in your discipline. And because it’s accessibly written, it travels well, goes overseas, gets re-tweeted and re-liked. It also gets read by academics outside your immediate sub-field and discipline, potentially pulling new audiences to your work.

Your project is linked to your profile where people can learn more about you, and connect.

Project documentation on Wevolver also often communicates your key messages to a far wider groups beyond academia itself. Thus it helps to create external impact for your work amongst practitioners in government or business or the professions as well.

High quality audience to engage with.

Tips

  • Keep your writing brief, simple and to the point for maximum impact.
  • Don’t imagine you’re talking to your peers, otherwise you’ll use terms that won’t be familiar to most audiences.
  • Write in short paragraphs.
  • Be careful to spell out acronyms the first time you use one.
  • Use hyperlinks

If you want to share your research via email, you can send this word document to richard [at] wevolver.com.


This page is based on two posts by the University of Sussex and the London School of Economics.