Consistent and descriptive file naming conventions help organise images, simplify collaboration, and make it easier to locate files in the future. Proper naming conventions also contribute to better SEO when images are used in web-based documentation.
Standardised Naming Format:
- Use a consistent format for all file names: Develop a standard format that includes relevant details such as the document title, section name, and a brief description of the image. Example: “User-Guide_Settings-Security-Tab-Screenshot.png.”
- Avoid using spaces in file names: Use hyphens or underscores instead of spaces to ensure compatibility with various systems and platforms. Example: “Dashboard_Main_View.png,” not “Dashboard Main View.png.”
Descriptive and Concise Names:
- Make file names descriptive but concise: File names should provide a clear indication of the image’s content without being overly long. Example: “Login-Screen-Capture.png,” not “Image1.png.”
- Include version numbers or dates if necessary: For files that may require updates or have multiple versions, include a version number or date to distinguish them. Example: “Diagram-User-Flow_v2.png.”
Dos:
- Use hyphens or underscores instead of spaces: Example: “System-Diagram_v1.png.”
- Make file names descriptive: Example: “Settings-Menu-Highlight.png.”
Don’ts:
- Don’t use vague or generic names: Avoid names like “Image1.png” or “Screenshot.png.”