Docs / wiki
Posted: Fri Sep 13, 2013 9:58 pm
I'm not sure if this is the right time to discuss this, and not, if its the right way.
And even if its really needed.
The question is, which I asked me some times since march, when I discovered this game, if there should be some day an "official doc", in which the player can look into, see how something is working and can dig even deeper to see do's or dont's. I know there are different opinions, from "the player should find it out all himself" to "I want to know what's in inserters, how they work and why are they called inserters, even when they obviously put out items? And what is with the fishes?".
My opinion is: if the game will be a success (and I hope it will and everything till now says, it will) then there are many websites, which offer some kind of "documentation", tips&tricks and so on. So in the end, they get the infos from "somewhere". By experience I can say, that I really, really recommend to have that more or less in a controlled order, because otherwise everybody says "hey, look, we have the best informations about the game!" And then everyone is doing its own stuff, no one is really contributing back to the community. Should be avoided.
That's the problem with having no "official documentation" and the only way to avoid that is to have one.
That was point 1.
For point 2 I thought, that some now think "this ssilk is funny, wants to have documenation for an unfinished game..."
I made a mind-map, which is an overview of my current thoughts about the docs. If someone wants I can send him the simple-mind mind-map, but because this is an proprietary format I prefer just pure text. Here are the current results:
I'm posting it to invite adding new points or discussing, if this or that is needed, or too much.
For example: I excluded the mods from the official docs, because I mean, it's not part of this docs.
And point 3 is, that I mean, that the current wiki is good enough for that job. I would like to contribute here, mainly it is only hard work, but for example for the list of all items or research I think programs should be used to generate the pages. ... Ok, getting too concrete now.
And even if its really needed.
The question is, which I asked me some times since march, when I discovered this game, if there should be some day an "official doc", in which the player can look into, see how something is working and can dig even deeper to see do's or dont's. I know there are different opinions, from "the player should find it out all himself" to "I want to know what's in inserters, how they work and why are they called inserters, even when they obviously put out items? And what is with the fishes?".
My opinion is: if the game will be a success (and I hope it will and everything till now says, it will) then there are many websites, which offer some kind of "documentation", tips&tricks and so on. So in the end, they get the infos from "somewhere". By experience I can say, that I really, really recommend to have that more or less in a controlled order, because otherwise everybody says "hey, look, we have the best informations about the game!" And then everyone is doing its own stuff, no one is really contributing back to the community. Should be avoided.
That's the problem with having no "official documentation" and the only way to avoid that is to have one.
That was point 1.
For point 2 I thought, that some now think "this ssilk is funny, wants to have documenation for an unfinished game..."
I made a mind-map, which is an overview of my current thoughts about the docs. If someone wants I can send him the simple-mind mind-map, but because this is an proprietary format I prefer just pure text. Here are the current results:
Code: Select all
Factorio Docs
Where
Forum
In game
Wiki
For whom
Player
Modder
Developers
Installation
Main-menu
Auto update
User login
Setup
Key bindings
Load/save Autosave
Map editor
Mods
Handle/install mods How to use mods
List of mods
Official
Inofficial
Docs Modding and scripting
Core Game
Basic concepts
Time
Day/night
Game time, ticks
Screen/windows
Main view
Map
Electric network
Crafting
Quick bar
Research
Inventory
Tiles
Sizes
Types
Items
Types
Select/place
Build
Build while running
Craft
Queue
Add/remove
Stacks
Selecting
Sizes
Control
Good mode
Player mode
Resources
Trees
Types
Mining fields
Iron/copper/stone/coal
Food
Fish
Alien eggs
Networks
Electric
Circuit
Production
Mining drills
Conveyor Belts
Inserters
Furnaces
Crafting
Automated production
Modules
Research
Research tree
Weapons
Defending
Active
Passive (Walls)
Creepers
Types of creepers
Buildings
Weapons
Vehicles
Car
Train
Appendix
List of all items
For belts: speed, items/min, tightness
Needed resources, crafting time...
For inserters: actions/min
For poles: area, cable length
Research tree
Dependencies
Useful combinations
Modules
Tables to compare combinations of modules with their resource need
Useful layouts
Mines
Storages
Belts
Furnaces
Assemblies
Research
Factory lines
Factory
Defending
Trains, train stations
Cars
Logistic robots
Electric network
Circuit network
Phases of game
For example: I excluded the mods from the official docs, because I mean, it's not part of this docs.
And point 3 is, that I mean, that the current wiki is good enough for that job. I would like to contribute here, mainly it is only hard work, but for example for the list of all items or research I think programs should be used to generate the pages. ... Ok, getting too concrete now.