티스토리 뷰

발표자인 Michael Meng은 테크니컬 라이터 경력을 가지고 있으며 지금은 Merseburg University의 교수로 일하고 있습니다. 

https://www.hs-merseburg.de/hochschule/information/personenverzeichnis/details/person/meng-michael-370/

 

Details

Tätigkeitsbereiche Textanalyse und Textproduktion Technische Dokumentation Usability und Forschungsmethoden

www.hs-merseburg.de

이번 발표는 SIGDOC 컨퍼런스에서 발표한 논문에 대한 이야기입니다. 논문 내용을 그대로 설명한 것은 아니고 어느 정도 컨퍼런스 주제에 맞추어 풀어서 설명을 하고 있습니다.

 

단일 연구라고 설명을 하는데 실험 집단의 규모(22명)가 작고 제한적이라 의미있는 결과라고 이야기하기는 어렵지만 그럼에도 참고할만한 내용이라고 설명을 하고 있습니다. 결론적으로는 API를 설명할 때 간단한 배경을 설명해주고 즉시 사용할 수 있는 예제 코드를 제공해주어야 사용자가 빠르게 API를 습득할 수 있다 뭐 그런 내용입니다.

https://pronovix.com/event/api-docs-virtual-2020/michael-meng

 

Michael Meng - Optimizing Documentation – Some Guidelines & Effects

The work reported in this talk was a part of a project that explored ways to make API docs more useful and effective in collaboration with Stephanie Steinhardt, Andreas Schubert. Presented at API the Docs Virtual 2020 on 4 November.

pronovix.com

SIGDOC 컨퍼런스 페이퍼는 비공개인데, 이 자료만 공개가 되어 있네요. 저자의 요청이었는지...

https://dl.acm.org/doi/10.1145/3380851.3416759

 

Optimizing API Documentation | Proceedings of the 38th ACM International Conference on Design of Communication

Overall Acceptance Rate 579 of 1,022 submissions, 57%

dl.acm.org

페이퍼에 대해 설명한 간단한 영상도 확인하실 수 있습니다.

 

 

댓글
댓글쓰기 폼