Overview of Project Design#
Summary#
Project design techniques can help researchers clearly identify and communicate their project goals, skill requirements and resource available to them. It ensures that all stakeholders can work together efficiently, apply reproducibility methods and communicate their work effectively with their target audience. A project design requires project leads, managers and organisers to be deliberate and clear about their expectations from the beginning of their projects to ensure successful implementation of their plans at all stages of research.
Fig. 13 Illustration of project design overview. The Turing Way project illustration by Scriberia. Used under a CC-BY 4.0 licence. DOI: 10.5281/zenodo.3332807#
In this chapter, we have curated good practices to ensure that we maintain good communication (and avoid miscommunication), create opportunities for collaboration and ultimately ensure reproducibility at different stages of the project.
Background & Motivation#
Everyone applies various design concepts to their project formally or informally. However, often we think about these concepts retrospectively, when the project is over and we gain a better understanding of design mistakes that could have been avoided with better planning and organisation.
This lack of planning contributes to the fact that most research work can not be directly and independently reproduced, and that communication and collaboration style across different groups differ and hence are challenging.
To help learn good practices, The Turing Way provides various chapters for reproducibility, communication and collaboration that we consider essential for research reproducibility. Although publications[TvdVDT20] and The Turing Way chapters on specific methods, tools and practices exist it can be overwhelming to know which chapters to read if you don’t already know about the concepts.
In this chapter, we have curated essential practices and recommendations and linked them to individual chapters across different guides.
Note
There are many chapters that we don’t link here to avoid overwhelming readers who are new to reproducible project design. We invite you to contribute to this chapter by adding important tools or practices that have not been mentioned here.
In the different subchapters we discuss how you can start planning for project design, the communication and collaboration aspect for ensuring reproducibility, tools and methods for reproducibility, version control and documentation aspects and sharing your research.
Learning from Mistakes#
“Building takes many, many mistakes.” ― Becky Chambers, The Long Way to a Small, Angry Planet
Learning about past design mistakes can give us insight into what we can do differently in the future. We asked a group of researchers to share what they consider their project design regrets, which we have summarised here:
Not advocating for clearer goals and success criteria from the beginning.
Not communicating the project vision clearly/often enough to the other team members.
Not ensuring that all stakeholders were fully aware of the nature of the project.
Not understanding that project design is about people first. Designs motivate stakeholders and allow collaboration and inclusion.
I guess I wrote these as actions I wish I had done better - Not setting short- and long-term milestones, communicating and enforcing norms for collaborator engagement, delegating work and project management tasks.
Not having documentation besides final reports. When being asked about the code or dataset (raw and process), step by step process from preparing data to getting the results, lack of documented guidance in one place made it hard to trace the project with all team members (classic problem).
Not properly taking into account the degree to which requirements will change throughout a project - which happens a lot in academia - and the effect this has on designs that then also need to change.
Trying to plan too much at the beginning and never getting started.
Feeling like I am always taking an ad hoc approach to planning a project and then feeling like I am spending too much time on the organisation side of the project because I don’t have a set workflow to handle project planning and design. Also, not knowing how project planning fits into project design.
Using a very messy excel to store/process data, the shame!
Over-engineering a design for features that didn’t end up being implemented (in life before academia!)
Not implementing Git flow from the start, and not teaching collaborators how to use Git flow.
Not developing tests until after a significant amount of code was written.
Not doing code reviews.
Not defining use scenarios for the software from the beginning, meaning we didn’t pay enough attention to data input and output.
Agonising too long before switching to objectively better design (particularly translating from a largely functional codebase to more object-oriented).
Going with options that team members are ‘comfortable’ with (for example, using outdated languages or platform-dependent compilers), rather than teaching team members new skills. Makes life more difficult in the long run.
Defining governance at different stages of the project or potential scenario planning for how governance might change as the project scales up/down/gains new users and so on.
Not thinking about community from the start, starting with a Code of Conduct, thinking about a Contributor License Agreement (intellectual property), what processes will be used and how they will work, how they will impact future contributors and the overall project.
This section summarises participants’ notes from a short workshop called “Good Practices for Designing Software Development Projects (The Turing Way)” at the Collaboration Workshop 2021 hosted by Software Sustainability Institute. The workshop was delivered by Malvika Sharan, Emma Karoune and Batool Almarzouq on 31 March 2021. Zenodo. DOI: 10.5281/zenodo.4650221.