Comments (7)
It might work well to partner with nodeschool on this to collect feedback from nodeschool students.
from docs.
This inspired me to suggest a Target Audience index for Guides and Topics to help steer users to docs appropriate for their skill levels in the roadmap. #59 (comment)
Any thoughts?
from docs.
+1 on nodeschool hook. Maybe also discuss nodeschool
's roadmap on this.
from docs.
Hi, I contacted Dror Feitelson from the Hebrew University who researches the understandability of code. I'm posting here his remarks on this issue:
great question.
I'd follow Gilb on this. Gilb's law states that "Anything you need to quantify can be measured in some way that is superior to not measuring it at all". specifically he suggests a methodology of components, scales and metrics:
- identify components of the thing you want to quantify
- for each component find the scale with which it can be measured
- and then find mechanisms to actually measure it in this scale
in your case of software documentation understandability, possible components that come to mind are:
- find which function to use
- how to use a certain function
- etc.
A scale can be the time needed by a to perform a certain . This is parameterized by developer type being a novice, a casual contributor, a core member, etc., and tasks being correcting a usage bug, using the function in new code, etc.
the mechanism can be to actually test this at least 5 times with different users and actually measure the time it takes them.
from docs.
/cc'ing @ashleygwilliams and @feross on this — I suspect the Foundation may be able to help out here. We'd likely want to run polls and possibly run recorded UX interviews (e.g., an interviewer asking a developer "Show me how you'd find out how to do XYZ with Node")
from docs.
@chrisdickinson Nice. Thoughts on how to conduct these polls and UX interviews? If there's a concrete proposal from the WG then I think we can take it to the board. Also, if possible, we should try to seek funding/volunteers from the community first, since more community ownership is always better IMO :)
from docs.
Closing as this repository is dormant and likely to be archived soon. If this is still an issue, feel free to open it as an issue on the main node repository.
from docs.
Related Issues (20)
- Node v6.3.1 docs: net.Socket HOT 1
- StackOverflow Documentation for Node.js HOT 5
- Circular reference for OS Constants HOT 3
- http ClientRequest documentation unclear about inheritance when visually scanning HOT 2
- .read() stream not fully explained HOT 9
- Rough Meeting Notes (2016-12-01 @ NINA) HOT 8
- What errors can be thrown?
- Async meetings HOT 6
- How-to use LetsEncrypt Guide HOT 13
- Meeting #1 HOT 33
- Add @vsemozhetbyt? HOT 4
- Meeting #2 HOT 2
- descriptions of "The module Object"'s property are not clear HOT 1
- clarity on asynchronous methods throwing exceptions HOT 2
- http.ClientRequest is missing some methods HOT 3
- Package documentation (how to intl) HOT 1
- Decharter this Working Group? HOT 8
- Better wording for modules_all_together HOT 3
- Suggestion: Return type in function declaration & possible option to view types by clicking HOT 2
- Improve the words usage in socket.setTimeout() definition HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from docs.