🖼️Content Methodology / Framework
Purpose: This workflow aims to classify and organize content using established methodologies and frameworks like Diataxis, DITA, or custom classification models. By applying these methodologies, teams can ensure that their content adheres to best practices for documentation structure and purpose, improving clarity and usability.
Prerequisites:
Content collection from documentation sources (GitBook, GitHub, etc.).
Diataxis Classifier, Topic Classifier, or DITA model pre-configured.
How it Works:
Loader Agents collect content from relevant sources.
The Diataxis Classifier or Topic Classifier categorizes the content based on methodology, whether it's instructional, technical, or procedural.
DITA models can be applied for more structured, reusable content modules.
Inputs:
Documentation and content from project sources.
Classification methodology or framework (e.g., Diataxis, DITA).
Processing:
The classifiers analyze the content and sort it according to the chosen methodology, ensuring that content is categorized based on its function (e.g., how-to guides, reference material).
Outputs:
A structured content classification based on the chosen methodology.
Organized content ready for reuse in other workflows like documentation generation or content transformation.
Usage: Admins set up the content classification through the admin panel, choosing the relevant classifier (e.g., Diataxis Classifier) and applying it to the documentation.
Example: The Diataxis Classifier categorizes a project’s documentation into sections such as "Tutorials," "Reference," "How-Tos," and "Explanations."
Advanced Features:
Customizable classification rules that adapt the framework to your specific documentation needs.
Troubleshooting:
Incorrect Categorization: Review and fine-tune the classifier's training data for better accuracy.
Logs:
Logs are available in the Content Methodology Logs, detailing how content was classified and organized.
Related Workflows:
Taxonomy Agent for structuring the overall content hierarchy.
Content Transformation Workflow for cross-format content publishing.
Last updated