Guidelines
The main output of the SESSAD project is guidelines based on the evidence of best practices and recommendations. The project team developed a set of descriptive interactive overviews on the available data, which report keyword overview, clustering based on application domains, and summary of the Likert scale quantitative evaluations.
Guidelines overview
Software development
- Use Github or GitLab tool for automatic and efficient deployment of web applications (CI/CD) and automate your build.
- Use microservices for your system to make the system more maintainable.
- Define a commit message format to be straightforward and easy to understand in CI/CD.
- Do code reviews and code refactoring to increase the readability of the code, reusability and testing.
- Use pull requests for Code Merge. It is better for code reviews.
- Consider Software quality assessment and improvement during the development process and the software system's lifecycle.
- Use Docker/Containers for Development and Deployment.
- Use a branching model and prevent your main branch from dangerous changes. Also, turn off the possibility of rewriting the history.
- Protect your web analytics data and the privacy of your visitors.
Testing
- Start with testing prototypes. This procedure minimises additional changes during the actual development of the functionality.
- Automate testing to cover your entire product and save time. The Codeception framework is an option that is easy to use and implement into the CI/CD process.
- Create test cases and follow them during testing.
- Use an A/B testing approach to determine which product version suits the project most or might lead to higher conversions.
- Write unit tests as a part of development.
UX and Graphic design
- Create Web prototypes in Figma. Prototypes replicate how users might interact with our designs. Use atomic design (It’s more aimed towards preparing proper design systems or functional prototypes that can be edited even without a designer’s help).
- Use a Site map as a graphical representation of the web architecture.
- Use opacity masks to create transparency, and colleagues first make and review pull requests.
- Follow a User-Centered Design process.
- Using Adobe Creative Cloud library is a straightforward way to transfer files and information to other workers.
- Use sharing of documents in Adobe Creative Cloud, especially InDesign. It is a quick way to create proofreading when creating typed publications.
- Create a company brand downloads library.
Data Analysis
- Take your time with Data preprocessing. This part must be done correctly so you don't have to return to the beginning in future stages. Take care of data quality.
- Providing deep learning models as web services.
- Assess a real-world clinical practice before data analysis.
- Automate your data quality checks.
- Make sure your visualisations are clear and correct. It should effectively communicate the data.
- Prepare and create open datasets. Governments and organisations can encourage innovation and improve decision-making by publicly sharing data.
- When creating reports (not only in MS PowerPoint), remember that sometimes less is more.
Project Management
- Collect and analyse customer needs for application behaviour.
- Communicate with your customer and developer regularly during the application development itself.
- Establish clear project goals.
- Use a business plan to start a project. You can use Business Model Canvas.
- Estimate the client’s future needs and requests for website development if possible. This often saves the time and effort of developers and coders because a specific modality or module is available on the website from the beginning.