From the course: Node.js: Debugging and Performance Tuning
Join today to access over 24,600 courses taught by industry experts.
Documenting problems
From the course: Node.js: Debugging and Performance Tuning
Documenting problems
- [Instructor] We've discussed how to frame and isolate issues in constructive ways and to measure performance. What should you be doing with problems as they come up? Write them down. That's it, I'm serious. When documenting an issue, describe it clearly so a casual reader understands your intent. Try to find a balance between being brief but thorough. Don't go overboard and write a novel, but give enough to work from. Give context about when and what was happening. Steps to replicate helps any engineer find and verify that a problem has been fixed. Finally, if appropriate, attach or include raw data such as performance measurements, error messages, and so forth. When tracking issues about any system, there are a few best practices that will make your life easier. First, document problems as promptly as possible when it's fresh in your mind. Keep the issues in a central location so both you and others can work on them. Finally, you'll need to be able to track progress in how the…
Practice while you learn with exercise files
Download the files the instructor uses to teach the course. Follow along and learn by watching, listening and practicing.
Download courses and learn on the go
Watch courses on your mobile device without an internet connection. Download courses using your iOS or Android LinkedIn Learning app.