Technical documentation (1 Viewer)

GraPeOwO

New Member
Joined
Aug 19, 2020
Messages
29
Gender
Male
HSC
2020
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

Member
Joined
Jul 24, 2020
Messages
61
Gender
Male
HSC
2017
1602419758976.png

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

LegoSlaughter

New Member
Joined
Oct 14, 2019
Messages
5
Gender
Male
HSC
2020
My teacher referred to it as intrinsic vs extrinsic with extrinsic being comments. Both are technically internal documentation though
 

Panda94

New Member
Joined
Feb 7, 2021
Messages
17
Gender
Male
HSC
2011
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
 

Users Who Are Viewing This Thread (Users: 0, Guests: 1)

Top