Files
owlen/conductor/product-guidelines.md

1.2 KiB

Product Guidelines

Prose Style

  • Professional & Direct: Use a professional tone that is helpful but concise.
  • Clarity over Verbosity: Explain complex actions briefly without being overly chatty.
  • Technical Accuracy: Use precise terminology when referring to code or system operations.

Technical Excellence

  • Idiomatic Rust: Follow standard Rust conventions (rustfmt, clippy).
  • Safety First: Prioritize memory safety and robust error handling. Use Result and Option effectively.
  • Performance: Ensure that file operations and LLM interactions are as efficient as possible.
  • Modularity: Maintain high cohesion and low coupling between crates.

Security & Privacy

  • Minimal Privilege: Only request permissions for necessary operations.
  • Secret Handling: Never log or store API keys or sensitive data in plain text.
  • Transparency: Clearly inform the user before executing potentially destructive commands.

UI/UX Design (CLI/TUI)

  • Unix Philosophy: Support piping and non-interactive modes where applicable.
  • Visual Feedback: Use progress indicators for long-running tasks.
  • Accessibility: Ensure the TUI is readable and navigable with standard terminal settings.