Communication

Communication to the outside world is important for visibility of Netherlands eScience Center projects and for building the user base.

Communication to other developers is a way to build community and contributors. It also increases our visibility in development world.

Home page

with all the necessary introduction information, links to documentation, source code (github) and latest release download (e.g. github.io pages)

The page should be created at the latest when the software is ready to be seen by the outside world. It is the place where people will learn about software, so it is important to describe its goals and functionality. It should be targeted towards non-programming users (unless software is meant for programers i.e library) but should have pointers for developers to more advanced resources (README.md)

Discussion list

Github issues, mailing list, not private email, for all project related discussions from the beginning of the project

There should be no private discussions about the project. Therefore once discussions are started (in the email), either move them to github issues or if they don’t fit into issues format any more, create the mailing list.

Demo docker image in dockerhub (with Dockerfile)

When applies, ususally for services.

If software is the service Docker image should be created at the very early stage. This will allow for easier testing and platform independent use.

An online demo

Only for web applications

Online demo should be available since first stable release. When the website is the user interface for researchers, make sure there is a development version running somewhere so that they can play around with it and give usability feedback.

Screencast

For most software it should be possible to create a screencast. This is very useful for people to get a quick impression of what exactly you are doing without diving into the code itself. In case your software does not have a graphical user interface, even a screencast of a terminal session can be quite informative. Try to add audio, or at least subtitles, so people know what is going on in the video.

At the Netherlands eScience Center we gather screencasts in our Youtube Channel.