Overview of Project Design¶
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.
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.
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 reproducibilty, tools and methods for reproducibility, version control and documentation aspects and sharing your research.