Skip to content

Completed Best Practices pages #4

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.

Sign up for GitHub

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

Merged
nolanlwin merged 1 commit into from
Aug 21, 2025
Merged

Completed Best Practices pages #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 111 additions & 0 deletions best-practices/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
---
title: 'Best Practices Overview'
description: 'Follow these guidelines to create effective documentation with Astrio'
---

## Overview

Follow these guidelines to create effective documentation with Astrio. These best practices will help you build better applications faster.

<CardGroup cols={2}>
<Card
title="Structure"
icon="folder-tree"
href="#structure"
>
Keep files concise and focused with clear organization
</Card>
<Card
title="Content"
icon="pen"
href="#content"
>
Write for your audience with practical examples
</Card>
<Card
title="Maintenance"
icon="arrows-rotate"
href="#maintenance"
>
Update regularly and gather user feedback
</Card>
<Card
title="Tools"
icon="gear"
href="#tools"
>
Leverage Astrio's visual editor and collaboration features
</Card>
</CardGroup>

## Structure

<Steps>
<Step title="Keep Files Concise">
Focus on one topic per file for better organization
</Step>
<Step title="Use Clear Headings">
Structure content with descriptive, hierarchical headings
</Step>
<Step title="Organize Logically">
Group related content and maintain consistent flow
</Step>
</Steps>

## Content

<Steps>
<Step title="Write for Your Audience">
Consider who will read and use your documentation
</Step>
<Step title="Include Examples">
Provide practical, real-world examples to illustrate concepts
</Step>
<Step title="Keep Language Simple">
Use clear, direct language that's easy to understand
</Step>
</Steps>

## Maintenance

<Steps>
<Step title="Update Regularly">
Keep documentation current with your application changes
</Step>
<Step title="Test Your Documentation">
Verify that instructions work as described
</Step>
<Step title="Gather Feedback">
Listen to users and improve based on their needs
</Step>
</Steps>

## Tools

<CardGroup cols={3}>
<Card
title="Visual Edits"
icon="wand-magic-sparkles"
href="/features/visual-edits"
>
Make quick updates with Astrio's visual editor
</Card>
<Card
title="Collaboration"
icon="users"
href="/features/collaboration"
>
Work together with your team in real-time
</Card>
<Card
title="Custom Domains"
icon="globe"
href="/features/custom-domain"
>
Use your own domain for professional branding
</Card>
</CardGroup>

<Note>
Following these best practices will help you create documentation that's both useful and maintainable. Start with the basics and refine as you learn what works best for your team.
</Note>
144 changes: 144 additions & 0 deletions best-practices/prompt-efficiency.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
---
title: 'Prompt Efficiency'
description: 'Optimize your prompts for better results with Astrio'
---

## Overview

Optimize your prompts for better results with Astrio. Well-crafted prompts lead to faster development and higher quality applications.

<CardGroup cols={2}>
<Card
title="Clear Instructions"
icon="bullseye"
href="#clear-instructions"
>
Be specific and action-oriented in your requests
</Card>
<Card
title="Structure"
icon="list"
href="#structure"
>
Organize your prompts for maximum clarity
</Card>
<Card
title="Examples"
icon="lightbulb"
href="#examples"
>
Learn from good and bad prompt examples
</Card>
<Card
title="Iteration"
icon="repeat"
href="#iteration"
>
Start simple and refine your approach
</Card>
</CardGroup>

## Clear Instructions

<Steps>
<Step title="Be Specific">
Clearly state what you want to achieve
</Step>
<Step title="Use Action Language">
Start with verbs like "create," "build," "design"
</Step>
<Step title="Include Context">
Provide relevant background information when needed
</Step>
</Steps>

## Structure

<Steps>
<Step title="Start with Main Request">
Lead with your primary goal or requirement
</Step>
<Step title="Add Supporting Details">
Include specifications, constraints, and preferences
</Step>
<Step title="End with Expected Outcome">
Describe what success looks like
</Step>
</Steps>

## Examples

### Good Prompts

<CardGroup cols={2}>
<Card
title="Specific Request"
icon="circle-check"
>
"Create a user guide for the login feature with screenshots"
</Card>
<Card
title="Detailed Context"
icon="circle-check"
>
"Build a landing page for a bakery with warm colors and mobile-first design"
</Card>
</CardGroup>

### Poor Prompts

<CardGroup cols={2}>
<Card
title="Vague Request"
icon="circle-x"
>
"Make something about login"
</Card>
<Card
title="No Context"
icon="circle-x"
>
"Create a website"
</Card>
</CardGroup>

## Iteration

<Steps>
<Step title="Start Simple">
Begin with basic requirements, then add complexity
</Step>
<Step title="Test Different Approaches">
Experiment with various prompt styles and structures
</Step>
<Step title="Learn from Results">
Analyze what works and refine your technique
</Step>
</Steps>

## Tips

<CardGroup cols={3}>
<Card
title="Use Bullet Points"
icon="list"
>
Break down complex requests into clear, scannable lists
</Card>
<Card
title="Specify Format"
icon="file-lines"
>
Mention your preferred output format and style
</Card>
<Card
title="Mention Audience"
icon="users"
>
Consider who will use or view the final result
</Card>
</CardGroup>

<Note>
Remember: The more specific and clear your prompt, the better the results. Don't be afraid to iterate and refine your approach based on what works best for your projects.
</Note>
Loading
Loading