CodeNewbie Community

loading...
Cover image for 3 takeaways from my experience as a Technical Reviewer

3 takeaways from my experience as a Technical Reviewer

Tyler V. (he/him)
He/Him. A developer that loves to teach others and spread my passion for Mathematics, Coding, and Pet Photography!In love with Vue.js πŸ’š
Originally published at terabytetiger.com ・3 min read

Recently I had the incredible opportunity to work as a technical reviewer for Packt reviewing chapters from Vue.js 3 Cookbook. I'll be working on a review of the book itself soonβ„’, but for now I want to touch on my experience to hopefully make things smoother for anyone going into the process!

1 - Technical Reviewing is really debugging

About halfway through my first chapter, I realized I was highlighting a lot of grammatical issues - so I double checked with the Project Manager and it turns out I should only review that the code worked!

"Perfect! That means it'll only take me like an hour tops per chapter!" - Me 4 hours before finishing my first chapter.

I thought this would mean the process would be a quick copy/paste the code from the book.

For some chapters, this would hold true. But for the others... Holy wow was I wrong!

There were a few code blocks where it seems like the author forgot to change the name of a variable or two (who hasn't been there before) and trying to debug exactly what was going on was quite the challenge!

2 - Ask for the author's repo up front

A few chapters in, I reached a pattern I had previously not seen for handling routing. After spending 30 minutes on it, I eventually moved on and handled the rest of the chapter only to come back and spend another hour on the unfamiliar pattern.

Still unable to solve the puzzle, I reached out to the project manager to request a code sample for that section from the author. Instead of just that code block, they ended up sending the full repo of code from all the chapters of the book, and what a lifesaver that turned out to be.

In a few other segments, that repo would save me time by offering a clear look at what the author was intending - at which point I would note how the author could make the instructions more clear and I was on my way again.

3 - Schedule a feedback gap after the first chapter

Due to the pandemic, the normal schedule of a chapter every few weeks got thrown for a loop and I received most of the chapters I needed to review immediately and the review cycle was every 3 days I was to send a chapter back to them.

In retrospect, I wish I had pushed back to create a gap between the first chapter and the second chapter to allow wiggle room with asking questions about the process during the first chapter. It worked out without it, but I was nervous going into the project and would have appreciated a window for feedback before jumping into more chapters for review (Hello, imposter syndrome, my old friend πŸ‘‹).

Conclusion

Overall, I think my first technical book review was a fairly positive experience - although probably won't be something I do again for a while since it ate up a lot of my free time. That said, it was a rewarding challenge to work through someone else's tutorials with the goal of improving the quality for readers following along more easily when the book releases!

If you've done a technical review for a publisher in the past, I want to know if experience aligns with mine! Leave a comment down below with your thoughts or other tips for a new technical reviewer πŸ‘‡

Discussion (0)