rdm
MkDocs
rdm | MkDocs | |
---|---|---|
2 | 114 | |
106 | 18,293 | |
0.9% | 0.9% | |
0.0 | 9.0 | |
over 1 year ago | 8 days ago | |
Python | Python | |
MIT License | BSD 2-clause "Simplified" License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
rdm
-
Ask HN: How do you keep track of software requirements and test them?
Been working as a consultant and engineer on FDA regulated software for about 8 years now. I have seen strategies from startups to huge companies.
I have seen requirements captured in markdown files, spreadsheets, ticket management systems like Redmine, Pivotal, Jira, GitLab, Azure Devops, GitHub Issues, and home grown systems.
If I had to start a new medical device from scratch today, I would use Notion + https://github.com/innolitics/rdm to capture user needs, requirements, risks, and test cases. Let me know if there is interest and I can make some Notion templates public. I think the ability to easily edit relations without having to use IDs is nice. And the API makes it possible to dump it all to yaml, version control and generate documentation for e-signature when you need it. Add on top of that an easy place to author documentation, non-software engineer interoperability, discoverable SOPs, granular permissions, and I think you have a winning combination.
-
How We Develop AI for 510(k)-Cleared Devices
We've had somewhat of a hard time applying agile to IEC 62304, although it's not impossible.
This document has some useful tips:
AAMI TIR45:2012 (R2018) Guidance On The Use Of AGILE Practices In The Development Of Medical Device Software
Also, we have an open source offering that includes an IEC62304 compliant software plan. You can check this out here:
https://github.com/innolitics/rdm/blob/master/rdm/init_files...
MkDocs
- I am stepping down from MkDocs
-
Alternatives to Docusaurus for product documentation
MkDocs is BSD-2-Clause licensed and has a vibrant community; GitHub Discussion is used for questions and high-level discussion, while the Gitter/Matrix chat room is used to discuss less complex topics. These communities provide essential resources and support.
- Ask HN: Tips to get started on my own server
-
Enhance Your Project Quality with These Top Python Libraries
MkDocs is a fast, simple and downright gorgeous static site generator that’s geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
-
Top 5 Open-Source Documentation Development Platforms of 2024
MkDocs is a popular static site generator designed explicitly for building project documentation. Its minimalist approach, flexibility, and ease of use have made it a favorite among developers and ideal for non-technical users.
-
5 Best Static Site Generators in Python
MkDocs is a popular static site generator specifically designed for project documentation. It is built on Python's Markdown processing engine and comes with a clean and responsive default theme. MkDocs is easy to configure, and its simplicity makes it an excellent choice for quickly creating documentation for your projects.
-
Creating a knowledge base website for work, do I need a database or can it be only front end designed?
Take a look at https://www.mkdocs.org
- MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
-
Examples with Github Pages?
I was thinking about using MkDocs, its usually used for documentation but I don't see why it couldn't be used for a normal wiki aswell. Since It's markdown you can just customize it like if it were a wiki, and a wiki doesn't really need backend stuff so I don't see a problem with it
What are some alternatives?
strictdoc - Software for technical documentation and requirements management.
sphinx - The Sphinx documentation generator
paperetl - 📄 ⚙️ ETL processes for medical and scientific papers
pdoc - API Documentation for Python Projects
wtfpython - What the f*ck Python? 😱
DocFX - Static site generator for .NET API documentation.
doorstop - Requirements management using version control.
Hugo - The world’s fastest framework for building websites.
professional-programming - A collection of learning resources for curious software engineers
Docusaurus - Easy to maintain open source documentation websites.
paperai - 📄 🤖 Semantic search and workflows for medical/scientific papers
BookStack - A platform to create documentation/wiki content built with PHP & Laravel