Peercoin Docs Maintenance

##Concept

I’ve been working with Kazzkiq on the design. This is just a concept, but what we have right now is very similar to the image below. It will say Docs rather than Wiki though…

##Organizing the Content

While we are in the process of finalizing the layout of the documentation, we wanted to start the discussion about how exactly to organize the content. We don’t want to just start writing content in an unorganized way. I would like all of you think of this as if we were writing one long digital book about Peercoin. Our main goal right now is to figure out what chapters we’ll need and the best way to organize and order all that information from beginning to end in order for newbies to fully understand it.

We also need to think about it in marketing terms as well. It can’t all be dry information. Think about it as if it was one giant marketing piece for Peercoin. We want it to be interesting so that people will read and learn as much of it as possible. Using this documentation, we will be able to communicate everything about Peercoin that we want to. All those interesting discussions and facts about Peercoin are currently buried in our forum and chat and it’s our task to bring it all out in an organized way and show off Peercoin in the best light possible.

As you can see from the concept image, the left pane features the table of contents. There are both categories and subcategories. As you scroll down the list, each category will open up to reveal a list of subcategories. As an example, the first category should probably be titled Introduction and it would most likely feature information about the very basics of Peercoin, what year it was created, who developed it, the fact that it’s the very first implementation of proof-of-stake as well as a hybrid, stuff like that.

The introduction category would then open up into multiple subcategories, the first being titled “What is Peercoin?” This would give a beginner summary on what the purpose is behind the network, the problems with PoW only and how PoW/PoS solves those problems. Other subcategories below that one could be focused on Security or governance, etc…

Eventually after the introduction is complete, we would move on to the next main category, which would contain a whole new list of subcategory topics. It’s up to us to decide what that is. I would suggest moving onto downloading the client, how to use it, how to secure it, how to mint, how to troubleshoot problems (maybe have a separate troubleshooting category for that). Maybe next would be a category on everything about PeerAssets. Somewhere along the line we would have a category for advanced material, which would contain detailed explanations of the protocol, the code and refutations of myths about PoS, etc… We would need to rely more heavily on our developers to write the advanced section.

To start this process off we should first think about all the different topics that need to be written about and list them all. Then we take that list and organize it into a basic structure from beginning to end, keeping in mind the order a newbie may need to be presented information in order to fully comprehend it. Then we take the organization of categories and subcategories and start filling it in with content. We will know as we get into the writing whether something in the organization needs to be changed or added.

If you need help getting everything started, try checking out my Intro to Peercoin thread for ideas. We can then figure out how to expand it as well as what can be improved in its presentation…

There is also our current wiki which is being replaced…

http://wiki.peercointalk.org/index.php?title=Main_Page

We should not just copy and paste from this. Specific content can be reused if the situation calls for it, but we should work on our presentation of the content so that it’s easy to understand and ordered in a way that makes sense for a person just getting into crypto.

Here is another wiki…