Skip to content

Latest commit

 

History

History
156 lines (98 loc) · 4.98 KB

USER_GUIDE.md

File metadata and controls

156 lines (98 loc) · 4.98 KB

User Guide

This guide provides detailed instructions on how to use the AI Article Generator for Medium.

Table of Contents

  1. Getting Started
  2. Generating Articles
  3. Editing Content
  4. Working with Images
  5. Managing Tags
  6. Quality Checking
  7. Publishing to Medium
  8. Settings and Configuration
  9. Tips for Best Results

Getting Started

First Launch

When you first launch the application, you'll see the branding window displaying the app's features.

App Branding Window

If you haven't set up your API key yet, click "Set Up API Key" to configure it.

Setting Up API Keys

  1. In the Settings dialog, enter your Google Gemini API key
  2. (Optional) Enter your Unsplash API key for better image search results
  3. Customize your author bio that will appear at the end of each article
  4. Click "OK" to save your settings

API Key Configuration

Generating Articles

Selecting a Topic

  1. Choose from the trending topics by clicking on one of the radio buttons, or
  2. Enter your own custom topic in the text field

Choosing a Niche

Select a niche from the dropdown menu. This helps the AI generate more relevant content for your target audience.

Formatting Options

Check "Optimize for Medium" to ensure the generated content is formatted correctly for Medium's editor.

Generating the Article

Click the "Generate Article" button to start the generation process. A progress dialog will show the status of the generation.

Article Generation Window

Editing Content

Article Title

Edit the title in the text field. A good Medium title should be catchy, clear, and relevant to your audience (6-10 words recommended).

Article Content

Edit the content in the large text area. You can make any changes you need to improve the article.

Tips for editing:

  • Ensure headings stand out
  • Keep paragraphs short (2-3 sentences)
  • Use bullet points for key information
  • Include a call to action at the end

Working with Images

Selecting Images

  1. The app automatically searches for relevant images based on your article title
  2. Click on an image to select it for your article
  3. You can select multiple images
  4. Toggle "Use Featured Images" to include or exclude images from your article

Downloading Images

Click the "Download" button on any image to save it to your computer.

Managing Tags

Editing Tags

  1. Click "Edit Tags" to open the tag selection dialog
  2. Select from suggested tags based on your article
  3. Choose from popular tags in your selected niche
  4. Add custom tags if needed
  5. You can select up to 5 tags for better discoverability on Medium

Tags Management Window

Copying Tags

Click "Copy Tags" to copy the selected tags to your clipboard for easy pasting into Medium.

Quality Checking

Running the Quality Check

Click "Check Article Quality" to analyze your article. The quality checker will:

  • Score your article out of 100
  • Provide feedback on areas that need improvement
  • Suggest specific improvements
  • Show a checklist of Medium publishing best practices

Article Quality Analyzer

Improving Your Article

Use the feedback from the quality checker to improve your article before publishing.

Publishing to Medium

Previewing Your Article

Click "Medium Preview" to see how your article will look on Medium.

Copying to Clipboard

Click "Copy to Clipboard" to copy your article (with title and content) to the clipboard.

Opening in Medium

  1. Click "Open in Medium" to open Medium's editor in your browser
  2. Sign in to your Medium account if needed
  3. Paste your article from the clipboard
  4. Add your selected images manually
  5. Add your tags for better discoverability
  6. Review and publish your article

Settings and Configuration

Accessing Settings

Click the "Settings" button in the top-right corner of the application.

Available Settings

  • Google Gemini API Key: Required for generating articles
  • Unsplash Access Key: Optional, for better image search results
  • Author Bio: Customizable text that appears at the end of each article

Tips for Best Results

  1. Choose Specific Topics: More specific topics often generate better, more focused articles
  2. Edit the Generated Content: Always review and edit the AI-generated content to add your personal touch
  3. Use Quality Checker: Run the quality checker before publishing to ensure your article meets best practices
  4. Select Relevant Images: Choose images that enhance your content and attract readers
  5. Use All 5 Tags: Maximize discoverability by using all available tag slots
  6. Customize Your Bio: Update your author bio to reflect your expertise and interests