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 write about things which depend on each other

I think this is a common situation. Most of the systems have different parts that interact with one another, and with the external word. The best presentations / documentations I have seen all sta...

posted 13y ago by Matthieu M.‭  ·  last activity 5y ago by System‭

Answer
#3: Attribution notice added by user avatar System‭ · 2019-12-08T02:09:11Z (almost 5 years ago)
Source: https://writers.stackexchange.com/a/4834
License name: CC BY-SA 3.0
License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision by user avatar Matthieu M.‭ · 2019-12-08T02:09:11Z (almost 5 years ago)
I think this is a common situation. Most of the systems have different parts that interact with one another, and with the external word.

The best presentations / documentations I have seen all start by first describing the environment in which the system evolves, with a high-level overview of the system itself. Then they quickly present one or two common uses and how they are dealt with.

I think you should probably follow the same pattern.

1. Introduction (gives some context)
2. Overview (of the different parts)

And then go on describing each part individually.

#1: Imported from external source by user avatar System‭ · 2012-01-18T08:30:30Z (almost 13 years ago)
Original score: 2