← Back
WizardDoc
WizardDoc Installation and Usage Guide
Prerequisites Installation
1
Install Node.js
1. Go to the official Node.js website: https://nodejs.org/
2. Download the recommended LTS version for your operating system
3. Run the installer and follow the on-screen instructions
4. Verify installation by opening a terminal/command prompt and typing:
node --version
npm --version
Both commands should display version numbers if installation was successful
2
Install Appium
1. Open a terminal/command prompt
2. Install Appium globally using npm:
npm install -g appium
3. Verify installation:
appium --version
Using WizardDoc
1
Start Appium Server
1. Open a terminal/command prompt
2. Start the Appium server by typing:
appium
3. Keep this terminal window open while using WizardDoc
2
Launch WizardDoc Application
1. Open the WizardDoc application on your computer
2. The main interface should show the document generator tool
3
Extract Test IDs
1. In the WizardDoc interface, locate the "Extractor" section
2. Choose your target platform:
For Android: Select the Android option. WizardDoc will automatically find the connected Android device/process
For iOS: Select the iOS option. You will need to manually select your app from the provided list
4
Generate Documentation
1. After selecting your platform and app (if iOS), click the "Generate Documentation" button
2. WizardDoc will begin scanning and retrieving test IDs from the selected application
3. Wait for the process to complete - this may take a few minutes depending on your app's size
5
Access Generated Documentation
1. Once the process completes, you can find your generated documentation file:
• Check the terminal window for the file path output
• Or navigate to the "Files" section within WizardDoc to locate your documentation
6
Customize Documentation (Optional)
1. Use the WizardDoc settings to customize your documentation:
• Change the theme for better readability
• Select your preferred language for the documentation
Troubleshooting Tips
• Ensure your mobile device is properly connected to your computer
• For Android, make sure USB debugging is enabled
• For iOS, ensure your device is trusted by your computer
• If WizardDoc cannot find your device, try restarting the Appium server