Technical documentation (1 Viewer)

[GraPeOwO]

I have a question regarding technical documentation, if someone could help me that would be great ^^
So with technical documentation, we have intrinsic documentation, such as meaningful identifiers and indenting of code. Are comments within the source code an example of intrinsic documentation or they are totally other form of technical documentation?

 

[cossine]

Going by "yorkyorkxp" it looks like commenting wouldn't be considered apart of intrinsic documentation but internal documentation

 

[LegoSlaughter]

My teacher referred to it as intrinsic vs extrinsic with extrinsic being comments. Both are technically internal documentation though

 

[Panda94]

Have you studied the existing SDK docs that most software (usually Saas) companies post?

Here is one such example - help.branch.io/developers-hub/docs/web-sdk-overview