-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Proposed SIG-Docs-Community Feature Grid #40
Comments
Assuming this is a companion or addition to the product feature grid in the upcoming 22.05 release notes? How did you determine the completeness score for the conceptual and tutorial content? What does "Complete" mean for docs? I think we should wait to release this until the Amazon docs team has had a chance to provide input from its audit, which is currently ongoing. I have a feeling there will be a lot less "Complete" scores than currently shown here. ;-) We should only list modules that are included with O3DE. Kythera AI is not one of them. Regarding the general format, please put the score first, followed by the description. Sorry for the extra work this will cause, but this will allow the scores to line up neatly and really aid the ability for readers to rapidly scan the table. See the preview of the product feature grid as an example, sizing your window to fit the table contents. |
Yes, this is the feature grid for documentation. Stephan and I settled on the workflows, modules, and columns to include last week. I think we both agreed that the format should be improved for future versions; I had concerns that this had to largely align with the format of other feature grids.
For conceptual content, if I couldn't identify that material was missing from the topic, it received a 'complete' score. For tutorial content, I considered all procedural material in addition to topics in the Tutorial section. I was expecting/hoping for many corrections to individual scores, I know the current ones are overly optimistic. I will remove Kythera. I can shuffle the score and description around no problem (and change which descriptions we use), generating the feature grid is automated! |
Notes from 5/17 meeting:
|
Important downstream consequences of accepting this change:
|
I think this information is useful in a table form, but
I'm wondering if there's a way to have this information at the top of each docs page, and then somehow run a script to aggregate it into this table. Then both use cases would be fulfilled. |
Closing proposal, feedback has been incorporated into RFC #64. |
Features(modules) are organized by workflow (in H3); they include the concepts, tools, and components associated with the workflow. Features are scored on four metrics: the completeness of conceptual material, tutorial content, sample content, and the API documentation for reflected features. Metrics that are not scored for a feature are labeled 'N/A'. A documentation link to conceptual material is listed in the last column. In some cases, I could not identify a primary location to link to a feature with partial coverage.
Sig-Docs-Community
Onboarding
Experience design
Actor development
World building
Look development
Multiplayer
Project development and team collaboration
Editor extension
Packaging and deployment
The text was updated successfully, but these errors were encountered: