You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Adam Bosen edited this page Aug 27, 2026
·
1 revision
This page is intended to start the conversation with a developer about what the software needs to do. Broadly, we divide these requirements into key features and design requirements. Initially, this documentation is used to plan a project timeline and prioritize issues for development, but can also be used later to communicate to prospective users the capabilities of the project.
Features
Provide a complete framework for documenting the design and implementation of new projects.
Start the conversation with developers to precisely outline project needs.
Requirements
Can be used without understanding how to use Git.
Is easy to update for both researchers and developers.
Please provide a broad description, 1 - 2 paragraphs, followed by short bullet pointed lists describing each feature and requirement of the software. These bullet points can be elaborated in sub-pages or in the issues list associated with the code. Consider marking features based on their status (e.g., "not started", "in progress", "completed") to keep track of milestones.