Difference between revisions of "Talk:BRL-CAD Primitives"

(Explained my revision of the introductory section.)
Line 20: Line 20:
  
 
[[User:JoelDBenson|JoelDBenson]] ([[User talk:JoelDBenson|talk]]) 20:22, 27 May 2013 (UTC)
 
[[User:JoelDBenson|JoelDBenson]] ([[User talk:JoelDBenson|talk]]) 20:22, 27 May 2013 (UTC)
 +
 +
Joel, impressive how you were able to gather all of our myriad documentation and developer notes that are scattered about.  Your cleanup and improvement efforts are very much appreciated, thank you in spades.
 +
 +
One of our long-term goals has been the cleanup and restructuring of the documentation like you've started, with our online documentation fully synchronized with our developer resources.  From a developer-centric perspective, this means bridging a technical gap between the software and the ease of use of wiki-style online editing.  This is because the code is constantly changing and we need some way to keep our documentation as up-to-date as possible, ideally as fast as the code is changing and ideally as easy to edit as possible (obviously).
 +
 +
Towards the technical end, most of our most current documentation is now in the XML Docbook format (html-style markup) in our repository.  The intent (which is not yet actualized) of getting that content synchronized onto the website.
 +
 +
My goal for many years now is to get bidirectional round-trip editing set up whereby our XML documents are published to the web and as developers change the docs, the website is updated.  Similarly, any user can go to one of the website pages (like you've been doing on the wiki) and those changes actually get staged for commit into our repository.  How this will eventually happen is obviously a major technical challenge.
 +
 +
Again, that setup is not yet in place but you will find remnants and information about it strewn about just like everything else.  I mention it only so you are aware of the long-term plan, not to derail your current (excellent) goals of cleaning up what we do have.
 +
 +
One piece of information you may not yet have come across is a [[TOC|table of contents]] that I recently pulled together.  That includes a massive Documentation section that I would greatly appreciate feedback on from your tech writer perspective.  I'd like to build up a consistent vision for where the website as a whole is going with an emphasis on organizing and cleaning up our absurdly extensive and poorly organized documentation.  You wouldn't know it but we actually have several *thousand* pages (million+ words) of documentation when you add it all up!
 +
 +
[[User:Sean|Sean]] ([[User talk:Sean|talk]]) 11:31, 31 May 2013 (UTC)

Revision as of 07:31, 31 May 2013

Other sources for information:

I've partially filled in the info for each primitive as I found it and as I've had time. Feel free to improve this page! Many of the primitives listed here are not fully implemented (present in in or create but absent from make or without a form when it should have one, etc.), it might be useful to add version numbers to indicate when the object was introduced or when it was completed, especially if there are older compiled binaries on the website that don't yet support them.

??Whoever wrote this should have signed it??

Revision of Introduction (5/27/13)

As a tech writer who is new to BRL-CAD, I'm finding that my study of it is being hampered by the current state of its documentation--so I decided to work on improving it. My first step was going to be revising the introductory section of this article to more completely describe the MGED commands for not only creating but also viewing and editing the properties of geometric primitives. But I decided all such information more properly belonged elsewhere, so I:

  • moved the information on creation methods to a new article,
  • retitled the old articles on determining and changing the properties of primitives to be consistent (leaving redirects in their old locations),
  • added links to those three articles to the introduction to this one, and
  • began reworking those three articles.

Of course, I also anticipate improving the rest of this article as time permits.

JoelDBenson (talk) 20:22, 27 May 2013 (UTC)

Joel, impressive how you were able to gather all of our myriad documentation and developer notes that are scattered about. Your cleanup and improvement efforts are very much appreciated, thank you in spades.

One of our long-term goals has been the cleanup and restructuring of the documentation like you've started, with our online documentation fully synchronized with our developer resources. From a developer-centric perspective, this means bridging a technical gap between the software and the ease of use of wiki-style online editing. This is because the code is constantly changing and we need some way to keep our documentation as up-to-date as possible, ideally as fast as the code is changing and ideally as easy to edit as possible (obviously).

Towards the technical end, most of our most current documentation is now in the XML Docbook format (html-style markup) in our repository. The intent (which is not yet actualized) of getting that content synchronized onto the website.

My goal for many years now is to get bidirectional round-trip editing set up whereby our XML documents are published to the web and as developers change the docs, the website is updated. Similarly, any user can go to one of the website pages (like you've been doing on the wiki) and those changes actually get staged for commit into our repository. How this will eventually happen is obviously a major technical challenge.

Again, that setup is not yet in place but you will find remnants and information about it strewn about just like everything else. I mention it only so you are aware of the long-term plan, not to derail your current (excellent) goals of cleaning up what we do have.

One piece of information you may not yet have come across is a table of contents that I recently pulled together. That includes a massive Documentation section that I would greatly appreciate feedback on from your tech writer perspective. I'd like to build up a consistent vision for where the website as a whole is going with an emphasis on organizing and cleaning up our absurdly extensive and poorly organized documentation. You wouldn't know it but we actually have several *thousand* pages (million+ words) of documentation when you add it all up!

Sean (talk) 11:31, 31 May 2013 (UTC)