Search Unity

  1. Unity 2019.2 is now released.
    Dismiss Notice

New Documentation section

Discussion in 'General Discussion' started by andeeeee, Jun 26, 2014.

  1. andeeeee

    andeeeee

    Joined:
    Jul 19, 2005
    Posts:
    8,768
    Tucked away at the very bottom of the page lies a new addition to the forum...

    We have had quite a few questions recently about the progress and direction of Unity's docs and so we are trialling a Documentation Section to promote further discussion.

    Basically, any thoughts, ideas, questions or criticisms you have about the docs are welcome, whether you want to discuss them with other users or simply to bring them to the doc team's attention. Also, the section is a good place to report faults with the docs. We believe this should offer a more streamlined way to address minor problems but of course, you can still file a standard bug report if you prefer.

    We look forward to seeing you in Docland soon! ;)
     
    StarManta and NomadKing like this.
  2. Aurore

    Aurore

    Head of Learn Content Production Unity Technologies

    Joined:
    Aug 1, 2012
    Posts:
    3,104
    This means you want me to move it up, doesn't it :p

    (the ordering actually messed up, fixing that)
     
    Last edited: Jun 27, 2014
  3. andeeeee

    andeeeee

    Joined:
    Jul 19, 2005
    Posts:
    8,768
    Absolutely. I can't imagine why the hottest topic on the forum has such a low billing ;)
     
  4. TylerPerry

    TylerPerry

    Joined:
    May 29, 2011
    Posts:
    5,577
    Is this the community documentation stuff someone mentioned a while back? If so it's really quite a poor effort.
     
  5. andeeeee

    andeeeee

    Joined:
    Jul 19, 2005
    Posts:
    8,768
    Don't worry, we are a bit more ambitious than that ;)

    The forum section is just a way to hear people's thoughts about what they want from the docs, where we could improve, etc. A very simple interim contribution system is in development and should be ready in a few weeks. This will just be a link on each doc page that lets you send a message back to us. A much more sophisticated editing system is also in development and a prototype has been demonstrated. This will probably be a few months away but it is already looking like a very solid platform for community contributions. More news as it arrives...
     
    Kaji-Atsushi likes this.
  6. TylerPerry

    TylerPerry

    Joined:
    May 29, 2011
    Posts:
    5,577

    Will be interesting to see :D
     
  7. Nikola-B

    Nikola-B

    Joined:
    Jan 31, 2014
    Posts:
    42
    I would love if users could contribute to the docs by adding notes and providing example code, etc. Obviously, user additions and changes would have to be reviewed before becoming visible to others.
     
  8. andeeeee

    andeeeee

    Joined:
    Jul 19, 2005
    Posts:
    8,768
    This is exactly what we have in mind. Our approach will be to incorporate new content from users into the main page text rather than having a list of notes at the bottom of the page. All additions will therefore be moderated and edited before publishing.
     
  9. The-Spaniard

    The-Spaniard

    Joined:
    Jan 7, 2012
    Posts:
    149
    A list of notes could be pretty useful in addition to additions to the main page. If you want to avoid clutter, maybe have a "discussion" page like most wikis have?
     
  10. Aurore

    Aurore

    Head of Learn Content Production Unity Technologies

    Joined:
    Aug 1, 2012
    Posts:
    3,104
    All perfect topics for the documentation forums eh ;)
     
    The-Spaniard likes this.