Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
Community Proposals
Community Proposals
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read See all your notifications »
Q&A

Post History

60%
+1 −0
Q&A How to include external references when writing internal documentation?

In the IT industry, we often write a lot of technical documentation meant for internal use only. Those documents are often stored in an internal wiki and accessed when the need arises. The conten...

3 answers  ·  posted 5y ago by Liquid‭  ·  last activity 4y ago by System‭

#4: Attribution notice removed by user avatar System‭ · 2019-12-13T11:56:50Z (over 4 years ago)
Source: https://writers.stackexchange.com/q/43557
License name: CC BY-SA 3.0
License URL: https://creativecommons.org/licenses/by-sa/3.0/
#3: Attribution notice added by user avatar System‭ · 2019-12-08T11:21:43Z (over 4 years ago)
Source: https://writers.stackexchange.com/q/43557
License name: CC BY-SA 3.0
License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision by (deleted user) · 2019-12-08T11:21:43Z (over 4 years ago)
In the IT industry, we often write a lot of technical documentation meant for internal use only. Those documents are often stored in an internal wiki and accessed when the need arises.

The content of the documents is not relevant here; the only relevant fact is that in the IT field you are not supposed to [_reinvent the wheel_](https://en.wikipedia.org/wiki/Reinventing_the_wheel). When writing a piece of code, or documenting a procedure, you are in fact supposed to search on Google (or SE sites, nonetheless) for others having faced a similar situation.

So, when it comes down to actually documenting what you have done,

## What is the best way to cite external references?

I often include a small list section with links at the end (or at the start) of the page, but I'm not sure it is the best method.

Keep in mind that internal documentation is not supposed to be read, ever, by customers. It usually stays private between colleagues.

#1: Imported from external source by user avatar System‭ · 2019-03-15T11:26:16Z (about 5 years ago)
Original score: 7