Welcome to the Nameback documentation. This directory contains comprehensive documentation for developers, contributors, and maintainers.
- User Guide - Main project README with installation and usage instructions
- AI Assistant Guide - Instructions for Claude Code when working on this project
- Release Process - How to create and publish releases
End-user guides and tutorials.
../README.md- Main project documentation- User Guide - Comprehensive user guide
Development guides, coding standards, and implementation details.
- TDD Implementation - Test-Driven Development summary and test coverage
- Refactoring Plan - Current refactoring work (Phase 1 complete)
- Refactoring Opportunities - Code quality analysis and improvement opportunities
- Kali Linux Packaging - Debian packaging for Kali Linux
Technical design documents and implementation analyses.
- Naming Heuristics - Algorithm for extracting meaningful file names
- Bundled Dependencies: Legal Analysis - License compliance for bundling dependencies
- Bundled Dependencies: Implementation - 4-layer fallback system implementation details
Release management, templates, and processes.
- Release Process - Automated release workflow (keep in root)
- Release Notes Template - Template for writing release notes
Security policies and vulnerability reporting.
- Security Policy - Vulnerability reporting and security practices
These files stay in the project root for discoverability:
README.md- Main project documentationCLAUDE.md- AI assistant instructionsRELEASING.md- Quick reference for releasesLICENSE- Project licenseCHANGELOG.md- Version history (auto-generated)
Internal development guides, coding practices, refactoring plans:
- TDD implementation notes
- Refactoring plans and opportunities
- Coding standards and conventions
- Development workflow guides
Technical design decisions, implementation analyses:
- System architecture
- Dependency management
- Implementation summaries
- Technical decision records (ADRs)
Release-related templates and guides:
- Release note templates
- Version upgrade guides
- Breaking change migration guides
End-user guides and tutorials (future):
- Installation guides
- Usage tutorials
- Feature walkthroughs
- FAQ
When adding new documentation:
-
Choose the right category
- User-facing? →
docs/user/ - Development process? →
docs/dev/ - Technical design? →
docs/architecture/ - Release-related? →
docs/release/
- User-facing? →
-
Use descriptive filenames
- Good:
TDD_IMPLEMENTATION.md,BUNDLED_DEPENDENCIES.md - Avoid:
notes.md,temp.md,doc1.md
- Good:
-
Update this index
- Add your new document to the appropriate section above
-
Link from root README
- If the documentation is important for new users/contributors
This documentation structure was established in November 2025 to organize the growing collection of development documents.
Previous State: 9 markdown files scattered in root directory
Current State: Organized into docs/ with clear categorization
Next Steps: Continue populating user guides and architecture docs