Missing Documentation

Forums: Missing Documentation
Generic forum to discuss Octane Render, post ideas and suggest improvements.
Forum rules
Please add your OS and Hardware Configuration in your signature, it makes it easier for us to help you analyze problems. Example: Win 7 64 | Geforce GTX680 | i7 3770 | 16GB

Missing Documentation

Postby sevengreen » Thu Jun 02, 2022 12:06 pm

sevengreen Thu Jun 02, 2022 12:06 pm
hey there

Some of the settings are completely missing from the documentation, or their descriptions vary significantly between the individual plugin and standalone documentation.
Comprehensive searches are also made more difficult because no uniform texts/search terms are used.

Example:
I searched in the Modo Documentation for the priority setting:
Results (3), but not the setting itself.

After that I searched the Standalone Documentation(13)
The explanation is kind of ok, but "priority changes priority" isn't that helpful?!

Then I found a thread > https://render.otoy.com/forum/viewtopic.php?f=30&t=78673&p=412084&hilit=nested+dielectrics#p412084
where they talk about the "priority setting".
The documentation was also referenced, but I just couldn't find that part.

Until I saw that this post was posted in the Cinema Forum... So I searched the Cinema Help for Priority as well.

tada ... first result, special page: nested dielectrics.(which the others don't have.)
And the explanation is by far the most extensive.

I think the point becomes clear.
Is it possible that at least the standalone docs are well documented and then sections copied into the other docs when it comes to basic settings instead of everyone redesigning the wheel?

sound like a win-win for me ?

And please, the more specific the better.
Contrast changes Contrast is ok. But why dont you say that it's only used to increase contrast. not decrease.


best wishes



as food for thought, what such a documentation can also look like.
https://www.sidefx.com/docs/houdini/render/nested.html
Attachments
screen_modo.png
screen_standalone.png
screen_cinema.png
User avatar
sevengreen
Licensed Customer
Licensed Customer
 
Posts: 14
Joined: Mon May 30, 2022 11:37 am

Re: Missing Documentation

Postby abreukers » Thu Jun 09, 2022 3:00 am

abreukers Thu Jun 09, 2022 3:00 am
hi

I'll send your sentiments to members involved with writing these docs. In the meantime, below is the respective status of the docs as of this date:

C4D Documentation: Version 2021.1
Standalone Documentation: Version 2021.1
Modo Documentation: Version 2019.1

Nested Dielectrics was a new feature introduced in v2020.2 (viewtopic.php?f=24&t=76901). Apologies for the confusion there. The Modo doc is still to catch up.
i72630QM @ 2.00GHz | 6GB RAM | 2GB GeForce GT 540M | Win7 64bit
abreukers
OctaneRender Team
OctaneRender Team
 
Posts: 498
Joined: Thu Aug 18, 2011 12:28 am

Return to General Discussion


Who is online

Users browsing this forum: Bing [Bot] and 22 guests

Fri Mar 29, 2024 3:05 pm [ UTC ]