Jump to content
This site uses cookies! Learn More

This site uses cookies!

armedunity.com uses cookies to improve user experience.

By continuing to use this site, you agree to allow us to store cookies on your computer.

themars2011

Need feedback for documentation [Kit]

Recommended Posts

Hello, everyone!

As some of you know, I am currently working on an FPS Kit. Soon the first version will be done (only 1 big feature missing and a few smaller ones) and I decided to begin with the documentation. It will be supplied as a PDF along with the project files (On Sellfy). This is my first attempt at creating a documentation (This file is not done but 60% functional, only the behaviour is missing, you will see what I mean) and I would like to hear your feedback as if you were a customer who is seeking help in this file.

Please login or register to see this link.

 

Thanks in advance :)

Share this post


Link to post
Share on other sites

My main problem are the following:

  • Not really organized, I would like to see a title on every page so I know what I am reading about.
  • There are no spacing at all, you should add some page brakes or just a horizontal line to brake it up a bit.
  • You should use different styles for different parts of the file. For example: TITLE, Subtitle, Heading, Normal text
  • Icons and 1x1 tables are a good way to highlight parts of the file.

Check out my asset's documentation Please login or register to see this link. , you can get some inspiration from it.

Share this post


Link to post
Share on other sites
Please login or register to see this quote.

 

Thank you, I will improve the points you listed but I don't understand the last part, what do you mean with 1x1 tables?

But what about the actual written information, would it be useful for you?

Share this post


Link to post
Share on other sites

The information is there but it needs formating.

1x1 table example:

 

Please login or register to see this attachment.

Share this post


Link to post
Share on other sites
Please login or register to see this quote.

 

Ah you use Google Docs, I made it w ith OpenOffice but Google Docs might be better don't you think?

Share this post


Link to post
Share on other sites
Please login or register to see this quote.

 

Yeah seems like a good idea, I'll post my progress then :)

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

×