One of the skills you’ll be working on in this class is how to articulate technical problems. This is an essential skill for any programmer as we spend a lot of time collaborating with others. When your create questions that are detailed, organized, and well thought out, your peers, instructors, and collaborators will be able to most efficiently help you.
Knowing this, here are some “dos and dont’s” of writing posts:
Do...
✅ Do write descriptive, clear titles.
✅ Do provide sufficient detail, including relevant code snippets.
✅ Do provide context: link to files in your Github repository that are relevant to the question. Make sure your repository is up to date with the latest changes.
✅ Do correctly format code and code-like content (e.g. error messages) using Markdown code fences; when applicable, fences should include the language extension (e.g. ```py) so it is properly syntax highlighted.
✅ Do reply to your classmates posts offering guidance or suggestions whenever possible; helping someone else spot a problem is a great way to practice/solidify the concepts we’re learning.
Don’t...
❌ Do not share screenshots of code - they can be hard to read and it’s not possible to copy/paste from them. Whenever possible, it’s better to include code snippets that are properly formatted with Markdown, or direct links to relevant code in Github.
❌ Do not be vague - statements like “It doesn’t work" are not helpful. Elaborate on what you expect the code to do and how it is failing to meet those expectations.
❌ Do not post questions specific to your personal involvement in the course (e.g. grading, submissions). Email these questions directly to the instructors.
One of the skills you’ll be working on in this class is how to articulate technical problems. This is an essential skill for any programmer as we spend a lot of time collaborating with others. When your create questions that are detailed, organized, and well thought out, your peers, instructors, and collaborators will be able to most efficiently help you.
Knowing this, here are some “dos and dont’s” of writing posts:
Do... ✅ Do write descriptive, clear titles. ✅ Do provide sufficient detail, including relevant code snippets. ✅ Do provide context: link to files in your Github repository that are relevant to the question. Make sure your repository is up to date with the latest changes. ✅ Do correctly format code and code-like content (e.g. error messages) using Markdown code fences; when applicable, fences should include the language extension (e.g.
```py) so it is properly syntax highlighted. ✅ Do reply to your classmates posts offering guidance or suggestions whenever possible; helping someone else spot a problem is a great way to practice/solidify the concepts we’re learning.Don’t... ❌ Do not share screenshots of code - they can be hard to read and it’s not possible to copy/paste from them. Whenever possible, it’s better to include code snippets that are properly formatted with Markdown, or direct links to relevant code in Github. ❌ Do not be vague - statements like “It doesn’t work" are not helpful. Elaborate on what you expect the code to do and how it is failing to meet those expectations. ❌ Do not post questions specific to your personal involvement in the course (e.g. grading, submissions). Email these questions directly to the instructors.
Example of a post that needs work
Example of a good post