-
Notifications
You must be signed in to change notification settings - Fork 139
How to write Wiki manuals
Pavel I. Kryukov edited this page Oct 9, 2018
·
1 revision
To my mind, the best guide we have is Smart Pointer Overview. When our project was hosted on GoogleCode, that page hit about 500 visitors per week. Since then, C++11 was released and many more manuals were published...
- It should contain a 'story': starting with motivation, each paragraph should follow the narration of next paragraph, from simpler topics to more complicated. Current version looks good from this perspective.
- It should behave as a cheat sheet. Reader should find information about the most common operations very quickly.
- In opposite, rarely needed information (like installation) or advanced topics may be referenced.
MIPT-V / MIPT-MIPS — Cycle-accurate pre-silicon simulation.