[Usecase] Use Case Documentation - REVIEW idea
Rathje, Ellen M
e.rathje at mail.utexas.edu
Fri Apr 8 14:03:52 CDT 2022
Hi all:
I thought I would pass on to y'all an idea from Clint about getting our use case documentation reviewed.
We want the documentation to be written for a specific audience--someone technically versed in a specific tool/domain (e.g., ADCIRC) but not familiar with all they can do with DesignSafe (e.g., how to run ensemble runs on the HPC systems using Juptyer). To ensure we are writing documentation at the right level (not too high, not too low, but just right...like Goldilocks), we suggest getting someone from your technical area to review your written documentation to give feedback. This feedback will be better than me reviewing it, given that I am not well versed in everyone's technical area.
If you have time, maybe you can do this before our deadline of Friday, April 15. Or you can do it after that submittal, and we will provide another opportunity for updating.
Thanks!
Ellen
_________________________________________
Ellen M. Rathje, Ph.D., P.E., F. ASCE
Professor
Janet S. Cockrell Centennial Chair in Engineering
Director, DesignSafe<https://www.designsafe-ci.org/> Cyberinfrastructure for Natural Hazards Research
Department of Civil, Architectural, and Environmental Engineering
University of Texas at Austin
Phone: 512-232-3683
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.designsafe-ci.org/pipermail/usecase/attachments/20220408/31ae19b7/attachment.html>
More information about the Usecase
mailing list