DEV Community

Tanya Schmidt
Tanya Schmidt

Posted on Edited on

Web and App Devs: How does technical writing keep your projects from falling apart?

Hey Everyone,
I’m a web development student finishing my first term at my community college. Currently I am working on a technical writing assignment. My goal is to understand How writing supports and facilitates the work of a web developer or app developer across a project.
If you have some time to spare, I would love to hear your perspective on these 5 questions (a couple of sentences would be plenty. More would be a dream I will read every word!)

  1. Starting a project: What kind of writing or documentation do you rely on most before you start writing code?
  2. During development: How does your writing change, or what new documentation is created once you are actively building?
  3. Working with others: We have spent a lot of time discussing audience and clear/concise writing. How does clear documentation help you work with teammates, designers and non-technical clients?
  4. Looking back: Have you worked on projects where poor or missing documentation has slowed you down? What happened?
  5. Helpful advice: What did you wish you knew about documentation in web dev/ app dev before your first project?

Thank you for helping a student learn about technical writing in web/ dev!

Note for my class citation: If you are comfortable, please share your role/title and how long you have worked in that role, and let me know if it is okay to cite your username/handle!)

Top comments (0)