💡 Just realised that you can use @coveragepy not only to determine your test coverage but also to find out how much of your codebase is present in your documented examples! 😁
I just got in contact with the yardoc #devs, and I am hoping I get a response soon, so I can fix the @JokeBot#documentation in the next release. I'll have to switch to RDoc if the issues don't get fixed soon.
You might be a #linguist, or an #ML#engineer, doing things like data specifications, filtering or pre-processing or training #ASR, #STT or #TTS models, or you might work in #fairness or #bias evaluation.
If so, I’d love your help to understand current #dataset#documentation practices, and what we can do to make them better as part of my #PhD#research 🤓 ⌨️ 🎤
The #survey takes 10-20 minutes to complete, and you can opt in to win one of 3 gift cards valued at $AUD 50 each.
Research Protocol 2021/427 approved by #ANU Human Research Ethics Committee
As a text-first boomer I completely agree screenshots and videos are no substitute for written documentation. The mileage of younger generations may vary.
"When you throw a screenshot out into Notion (Wiki, Confluence, et cetera), you’re effectively defining a word WITH the word."
Our #Madrid_DAI colleagues & partners offer a course on #documentation of architectural remains for #archaeologists, master & doctoral students from Europe & North Africa.
You might be a #linguist, or an #ML#engineer, doing things like data specifications, filtering or pre-processing or training #ASR, #STT or #TTS models, or you might work in #fairness or #bias evaluation.
If so, I’d love your help to understand current #dataset#documentation practices, and what we can do to make them better as part of my #PhD#research 🤓 ⌨️ 🎤
The #survey takes 10-20 minutes to complete, and you can opt in to win one of 3 gift cards valued at $AUD 50 each.
Research Protocol 2021/427 approved by #ANU Human Research Ethics Committee
At #CHI2023, @mnassif presenting his PhD work "A Field Study of Developer Documentation Format".
We synthesized five #documentation presentation guidelines and used our Casdoc documentation generator to evaluate the impact of these guidelines in a #FieldStudy with 326 participants who used 126 documents over several months.
Sometimes we got to build workarounds to get around bugs that are not within our reach to fix (eg. a 3rd party library).
Those workarounds should be as short-lived as possible and to know when something is a workaround and when it's safe to be removed, we need to document it.
I ran into this at work while doing a code review the other day and decided to write a blog post.
Do you work with #voice or #speech#data? You might contribute data, write data specifications for collection, perform filtering or pre-processing, train #ASR or #TTS models, or design or perform evaluations on #ML speech models.
If so, I’d love your help to understand current #dataset#documentation practices, and what we can do to make them better as part of my #PhD#research
The #survey takes 10-20 minutes to complete, and you can opt in to win one of 3 gift cards valued at $AUD 50 each
Research Protocol 2021/427 approved by #ANU Human Research Ethics Committee
Do you work with #voice or #speech#data? You might contribute data, write data specifications for collection, perform filtering or pre-processing, train #ASR or #TTS models, or design or perform evaluations on #ML speech models.
If so, I’d love your help to understand current #dataset#documentation practices, and what we can do to make them better as part of my #PhD#research
The #survey takes 10-20 minutes to complete, and you can opt in to win one of 3 gift cards valued at $AUD 50 each.
Research Protocol 2021/427 approved by #ANU Human Research Ethics Committee
@ChristosArgyrop@bentomn@kyleha@cubic_logic Agreed, poor internal docs are rampant regardless of language, in stark comparison to the #OpenSource#Perl libraries on #CPAN. So much there is well-documented and -tested and the culture encourages continuous improvement.
Perl #developers that turn a blind eye to CPAN are doubly handicapped: they (poorly) reinvent the wheel and miss exemplars of good #documentation and #testing.