# Technical Documentation \<code\> requirement

**URL:** <https://forum.freecodecamp.org/t/technical-documentation-code-requirement/429012>\
**Category:** General\
**Created:** [November 5, 2020, 11:06pm UTC](https://forum.freecodecamp.org/t/technical-documentation-code-requirement/429012 "2020-11-05T23:06:39Z")\
**Posts on this page:** 5\
**Page:** 1

<div class="post-metadata">

**Author:** ![magopolis](https://sea3.discourse-cdn.com/freecodecamp/user_avatar/forum.freecodecamp.org/magopolis/32/134175_2.png) [@magopolis](https://forum.freecodecamp.org/u/magopolis)\
**Post date:** [November 5, 2020, 11:06pm UTC](https://forum.freecodecamp.org/t/technical-documentation-code-requirement/429012/1 "2020-11-05T23:06:39Z")

</div>

Hi,

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?

---

<div class="post-metadata">

**Author:** ![ArielLeslie](https://sea3.discourse-cdn.com/freecodecamp/user_avatar/forum.freecodecamp.org/arielleslie/32/264841_2.png) [@ArielLeslie](https://forum.freecodecamp.org/u/ArielLeslie)\
**Post date:** [November 5, 2020, 11:14pm UTC](https://forum.freecodecamp.org/t/technical-documentation-code-requirement/429012/2 "2020-11-05T23:14:33Z")

</div>

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.

---

<div class="post-metadata">

**Author:** ![magopolis](https://sea3.discourse-cdn.com/freecodecamp/user_avatar/forum.freecodecamp.org/magopolis/32/134175_2.png) [@magopolis](https://forum.freecodecamp.org/u/magopolis)\
**Post date:** [November 6, 2020, 12:23am UTC](https://forum.freecodecamp.org/t/technical-documentation-code-requirement/429012/3 "2020-11-06T00:23:59Z")

</div>

Thanks,

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.

---

<div class="post-metadata">

**Author:** ![ArielLeslie](https://sea3.discourse-cdn.com/freecodecamp/user_avatar/forum.freecodecamp.org/arielleslie/32/264841_2.png) [@ArielLeslie](https://forum.freecodecamp.org/u/ArielLeslie)\
**Post date:** [November 6, 2020, 4:55am UTC](https://forum.freecodecamp.org/t/technical-documentation-code-requirement/429012/4 "2020-11-06T04:55:45Z")

</div>

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

---

<div class="post-metadata">

**Author:** ![ILM](https://sea3.discourse-cdn.com/freecodecamp/user_avatar/forum.freecodecamp.org/ilm/32/363239_2.png) [@ILM](https://forum.freecodecamp.org/u/ILM)\
**Post date:** [June 1, 2021, 6:36pm UTC](https://forum.freecodecamp.org/t/technical-documentation-code-requirement/429012/5 "2021-06-01T18:36:58Z")

</div>

Closed on June 1, 2021, 6:36pm UTC


