Technical Documentation <code> requirement


I’m curious about the requirement on this project to insert <code> elements. The example project is a technical paper about JavaScript so it makes sense their but I wasn’t planning on using that topic. Not a problem because I can just put some code in to satisfy the test. My question is whether I might be misunderstanding that part of the assignment. Is it that simple? They just want me to enter 5 code elements? Even if its a document about HVAC repair?

In programming circles, you’ll see a lot of conversation about (technical) documentation, in reference to explaining an API, library, project contribution, etc. Reading and writing good documentation is an important skill and doing this project about a code related subject give you a good reason to go do some research about the tools you are learning to use. It’s assumed that your project will be programming related technical documentation.

That said, you certainly can do the project about HVAC repair and just find some good places to use code blocks stylistically.


HVAC was just a hypothetical. I was going to focus on building the template from scratch and fill it with lorem ipsum. I take your point though, and Ill think about maybe making it a technical piece about building a loripsum generator. Thanks for the recommendation.

I look forward to seeing what you build. Happy coding!