Tutorial Intro

TechDOCS is a documentation portal for engineering teams, technical writers, and platform owners who need clear, maintainable docs.

Getting Started

Use this page to understand the portal structure and choose the right learning path.

How this portal is organized

• Writing Best Practices: standards for clarity, structure, terminology, and reviews.
• Guides: practical user, admin, installation, integration, and API documentation.
• Cloud & DevOps: provider-specific cloud references and delivery operations.
• Blog: implementation notes and lessons learned from documentation projects.

Suggested first path

If you are new to technical documentation, start with this sequence:

1. Open Writing Best Practices
2. Review audience and content-type guidance
3. Apply the review checklist to one live page
4. Move to tooling and automation topics

If you are documenting a product or platform, start with guides:

1. Draft one user guide and one installation guide for a single workflow
2. Publish or update an API reference page
3. Link operational runbooks from the DevOps section

Local development

Run the portal locally while editing content:

yarn start

The site is available at http://localhost:3000 and hot-reloads when files change.