Skip to content

Conversation

@ajay-dhangar
Copy link
Member

This pull request introduces the complete content suite for the Technical Writer Tutorial under the /tutorial/technical-writer/ path. This adds a few new documentation pages covering fundamental, tool-specific, and advanced career topics.

This work marks the official launch of the dedicated technical writing track for the CodeHarborHub community.


Key Changes & Scope

This PR includes three main categories of content, adding crucial educational material for our users:

1. Foundational Documentation Principles

  • API Documentation: The standard three-pillar structure (Conceptual, Tutorial, Reference).
  • User Manuals: Focus on task orientation and audience analysis.
  • Technical Reports: Formal structure for internal, analytical documentation.
  • Release Notes: Concise, scannable communication of product changes.

2. Tooling and Workflow Mastery

  • Markdown/MDX: Syntax guide and best practices.
  • Git and GitHub: Essential version control workflow (branching, PRs, merging).
  • Docs Platforms: Overview of SSGs (Docusaurus), Hosted, and CCMS solutions.
  • Style Guides & Enhancement Tools: Implementing linters for consistency.

3. Advanced and Career Topics

  • Writing for Developers: Focus on "Zero-Friction Utility" and the Diátaxis model.
  • Portfolio Building: The required projects and the Docs-as-Code portfolio workflow.
  • Open Source Contributions: Guide to collaboration and PR etiquette.
  • Localization & SEO: Strategies for global discoverability and accessibility.
  • Career Path: Progression from junior to principal/manager roles.

Checklist for Reviewers

Please review the following aspects:

  • Build Check: Verify that the Docusaurus build runs successfully without errors (especially for *.mdx syntax).
  • Style Guide: Check for consistency in tone, capitalization, and adherence to the general style guide.
  • Navigational Integrity: Ensure all internal links (e.g., links between topics like API Documentation and User Manuals) resolve correctly.
  • Component Usage: Verify that custom components (<LinkCard>, <SkillCard>) render correctly on the pages where they are used (especially in the /resources/ section).

/cc @ajay-dhangar

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job, @ajay-dhangar! 🎉 Thank you for submitting your pull request to CodeHarborHub. We appreciate your contribution and enthusiasm! Our team will review it soon. If you have any questions or need further assistance, feel free to reach out. Thanks for contributing!

@ajay-dhangar ajay-dhangar merged commit 4c5c93c into main Nov 8, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants