Diátaxis: A systematic approach to technical documentation authoring. -- https://diataxis.fr/ provides a methodology for systematization of the documentation and training resources worth following.
We came to the need to restructure documentation , as to shift https://reprostim.readthedocs.io/en/latest/notes/psychopy-notes.html from Notes into some other section to improve visibility and reuse. But overall I feel that we could approach such restructuring more methodically and thus consider diataxis for it.
Inspired by the talk @julia-pfarr of at distribits: https://www.youtube.com/watch?v=fiaxXjCiQCg&list=PLEQHbPfpVqU6_bZ4gUQn_9OX-LvDmKoby&index=3 on their refactoring of nipoppy documentation: https://nipoppy.readthedocs.io/en/latest/ which follows that principle!
Moreover I think @julia-pfarr experimented during distribits hackathon with using AI with https://github.com/github/spec-kit to formalize and facilitate such a refactoring. @julia-pfarr was there some success or what would be additional (to the talk) advice you could give now for how for us to restructure and expand documentation.
Diátaxis: A systematic approach to technical documentation authoring. -- https://diataxis.fr/ provides a methodology for systematization of the documentation and training resources worth following.
We came to the need to restructure documentation , as to shift https://reprostim.readthedocs.io/en/latest/notes/psychopy-notes.html from Notes into some other section to improve visibility and reuse. But overall I feel that we could approach such restructuring more methodically and thus consider diataxis for it.
Inspired by the talk @julia-pfarr of at distribits: https://www.youtube.com/watch?v=fiaxXjCiQCg&list=PLEQHbPfpVqU6_bZ4gUQn_9OX-LvDmKoby&index=3 on their refactoring of nipoppy documentation: https://nipoppy.readthedocs.io/en/latest/ which follows that principle!
Moreover I think @julia-pfarr experimented during distribits hackathon with using AI with https://github.com/github/spec-kit to formalize and facilitate such a refactoring. @julia-pfarr was there some success or what would be additional (to the talk) advice you could give now for how for us to restructure and expand documentation.