Questions tagged [documentation]
Documentation is a description of code written in day to day language. Questions using this tag can ask about teaching how to write proper documentation.
6
questions
8
votes
7
answers
335
views
What things aren't obvious about reading documentation? How can I explain to others how to do it?
As an experienced programmer and frequent user of Stack Overflow, I often run into this problem. I try to tell people calmly to read the documentation for whatever it is they are trying to use - but ...
- 181
3
votes
3
answers
155
views
How useful is English (pseudocode and documentation) in aiding understanding?
I'm a freelance tutor working with high school students, giving them programming assignments in languages like Python, Java, C++, and others.
In recent months I've seen the value of using English - ...
- 457
1
vote
2
answers
124
views
What are the basics of CS that I should know, before I start my journey into machine learning
I am a non-cs graduate and would love to be a machine learning engineer.
I have learned to code, and know the basics of Machine learning. Now I would like to know what "basics of CS" I should learn ...
- 169
12
votes
5
answers
399
views
How to convince students that self learning is an important skill?
I am teaching beginner programmers with a variety of backgrounds. Towards the end of the course, we encourage more independent and team based learning rather than lecture based learning. This is ...
- 223
-3
votes
1
answer
216
views
Is there a textual alternatives to UML diagrams? [closed]
I found by studying computer science that there are UML diagrams. I found them useful but sometimes too slow to draw. Is there some alternatives to UML that does the same but is easy to type for ...
3
votes
3
answers
48
views
How to document the developed work using an agile methodology?
In the final report of their internship, the students of our school must have one chapter where they "document" the developed work. When using the “waterfall” methodology, they usually have one sub-...
- 2,201