EAWFStandard - Revision history

Admin: /* EAWF Standards */

2026-08-04T14:30:05Z

EAWF Standards

← Older revision		Revision as of 07:30, 4 August 2026
Line 18:		Line 18:
	** [[StandardsCredits\|Credits and Attribution]]		** [[StandardsCredits\|Credits and Attribution]]
	** [[StandardsDocs\|Documentation Headers and Footers]]		** [[StandardsDocs\|Documentation Headers and Footers]]
			** [[Business\|Business Plan Templates]]

	== Programs/Scripts ==		== Programs/Scripts ==
	=== BTC ===		=== BTC ===

Admin at 20:39, 11 July 2026

2026-07-11T20:39:31Z

@@ Line 8: / Line 8: @@
 The objective is simple:
-* Deliver software that is professional, predictable, easy to install, easy to maintain, and enjoyable to use.
+* Deliver software that is useful, professional, predictable, easy to install, easy to maintain, and enjoyable to use.
-* Every EAWF project should provide a consistent experience regardless of language, operating system, or application.
+* Every EAWF project should provide a consistent user interface and experience regardless of language, operating system, or application.
----
+== EAWF Standards ==
 == Core Philosophy ==

Admin at 07:11, 7 July 2026

2026-07-07T07:11:25Z

@@ Line 77: / Line 77: @@
 The uninstaller should remove the application while preserving user data unless explicitly requested otherwise.
----
+== Linux Standards ==
-# Linux Standards
+* Programs should follow normal Linux conventions.
-Programs should follow normal Linux conventions.
+* Programs usually run from <code>/usr/local/bin</code>
-## Program
+* User Configuration: <code>~/.config/<project>/</code> e.g., <code>~/.config/connect/</code>
-```
+* Documentation Location: <code>/usr/local/share/doc/<project>/</code>
-## User Configuration
+* Manual Pages: <code>/usr/local/share/man/man1/</code> e.g., <code>/usr/local/share/<project>/examples/</code>
-```
+* Logs: <code>~/.local/state/<project>/</code>
-~/.config/<project>/
+** Applications should create log directories only when logging is actually needed.
-Example:
+* Cache:
-```
+* Avoid creating unnecessary files or directories "just in case."
----
+* Configuration Philosophy: Separate configuration into logical responsibilities.
-## Documentation
+* Project Configuration: Contains definitions describing the project itself.
-```
+ Example:
-/usr/local/share/doc/<project>/
+ * Servers
-```
+ * Hosts
----
+* User Settings: Contains user preferences.
 Example:

Admin: Admin moved page EAWF:EAWFStandard to EAWFStandard over redirect

2026-07-06T19:29:19Z

Admin moved page EAWF:EAWFStandard to EAWFStandard over redirect

← Older revision		Revision as of 12:29, 6 July 2026
(No difference)

Admin: Admin moved page EAWFStandard to EAWF:EAWFStandard: Setting up Namespace

2026-07-06T16:19:37Z

Admin moved page EAWFStandard to EAWF:EAWFStandard: Setting up Namespace

← Older revision		Revision as of 09:19, 6 July 2026
(No difference)

Admin at 06:36, 4 July 2026

2026-07-04T06:36:42Z

← Older revision		Revision as of 23:36, 3 July 2026
Line 1:		Line 1:
			{{Parent\|Main_Page}}
	== EAWF Software Development Standard v1.0 ==		== EAWF Software Development Standard v1.0 ==

Admin: Created page with "== EAWF Software Development Standard v1.0 == == Purpose == The EAWF Software Development Standard defines the minimum quality, documentation, installation, and support requirements for all software released by EAWF. The objective is simple: * Deliver software that is professional, predictable, easy to install, easy to maintain, and enjoyable to use. * Every EAWF project should provide a consistent experience regardless of language, operating system, or application...."

2026-07-04T06:36:07Z

Created page with "== EAWF Software Development Standard v1.0 == == Purpose == The EAWF Software Development Standard defines the minimum quality, documentation, installation, and support requirements for all software released by EAWF. The objective is simple: * Deliver software that is professional, predictable, easy to install, easy to maintain, and enjoyable to use. * Every EAWF project should provide a consistent experience regardless of language, operating system, or application...."

New page

== EAWF Software Development Standard v1.0 ==

== Purpose ==

The EAWF Software Development Standard defines the minimum quality, documentation, installation, and support requirements for all software released by EAWF.

The objective is simple:

* Deliver software that is professional, predictable, easy to install, easy to maintain, and enjoyable to use.

* Every EAWF project should provide a consistent experience regardless of language, operating system, or application.

---

== Core Philosophy ==

The EAWF Software Development Standard is based on the following principles:

* Follow established Linux conventions whenever practical.
* Keep programs simple.
* One tool should perform one primary task well.
* Do not expose implementation details to the user.
* Auto-detect sensible defaults whenever possible.
* Allow users to customize behavior without modifying program code.
* Never overwrite user configuration without permission.
* Documentation is part of the product.
* Installation and removal should be safe and straightforward.

---

=== Quality Standard ===

A version 1.0 release must satisfy the following requirements.

==== Functional: ====

* Stable operation
* No known functional defects
* Predictable behavior
* Clear error handling
* Professional command output

---

==== User Experience ====

* Clean command syntax
* Consistent help screens
* Quiet operation
* Friendly messages
* No unnecessary technical output
* Consistent formatting throughout the application

---

==== Installation ====

Every project should include:

* `.install.sh`
* `.uninstall.sh`
* README.md
* CHANGELOG.md
* LICENSE
* Man page
* Example configuration files

The installer should:

* Install safely
* Preserve existing user configuration
* Create missing configuration files from examples
* Verify prerequisites
* Report missing dependencies clearly

The uninstaller should remove the application while preserving user data unless explicitly requested otherwise.

---

# Linux Standards

Programs should follow normal Linux conventions.

## Program

```
/usr/local/bin
```

## User Configuration

```
~/.config/<project>/
```

Example:

```
~/.config/connect/
```

---

## Documentation

```
/usr/local/share/doc/<project>/
```

---

## Manual Pages

```
/usr/local/share/man/man1/
```

---

## Examples

```
/usr/local/share/<project>/examples/
```

---

## Logs

When required:

```
~/.local/state/<project>/
```

Applications should create log directories only when logging is actually needed.

---

## Cache

Applications should **not** create cache directories unless there is a legitimate performance benefit.

Avoid creating unnecessary files or directories "just in case."

---

# Configuration Philosophy

Separate configuration into logical responsibilities.

## Project Configuration

Contains definitions describing the project itself.

Example:

* Servers
* Hosts
* Network links
* Project mappings
* Deployment targets

Example:

```
connect.conf
```

---

## User Settings

Contains user preferences.

Example:

* Preferred editor
* Preferred file manager
* Color preferences
* Future display options

Example:

```
settings.conf
```

---

# Auto First

Every application should attempt to make intelligent default decisions.

Users should only need to customize behavior if they want something different.

Examples:

* Respect `$EDITOR`
* Auto-detect running file manager
* Automatically disable color when output is redirected
* Honor existing SSH configuration

---

# Customization

Power users should always be able to override automatic behavior.

Customization should be achieved through configuration files rather than modifying application code.

---

# Documentation

Every project should provide documentation at three levels.

## README

Project overview

* Purpose
* Installation
* Quick start
* Examples
* Philosophy

---

## Man Page

Reference documentation

* Synopsis
* Commands
* Files
* Environment
* Examples
* Exit codes

---

## Website

The EAWF website serves as the living documentation.

It may contain:

* Tutorials
* Screenshots
* Frequently Asked Questions
* Configuration examples
* Troubleshooting
* Release notes
* Known issues
* Future enhancements

---

# Error Handling

Applications should report problems in language users understand.

Avoid exposing raw command output unless it is genuinely useful.

The user should see results rather than internal implementation details.

---

# Design Philosophy

Good software should:

* Respect the operating system.
* Respect the user's configuration.
* Respect the user's time.
* Stay out of the way.
* Be reliable enough that users stop thinking about it.

---

# EAWF Motto

**Simple. Predictable. Configurable.**

Applications should be approachable for beginners while remaining powerful enough for experienced users.

---

# Release Criteria

A project may be declared Version 1.0 when it:

* Meets all functional requirements.
* Meets the EAWF Software Development Standard.
* Includes complete documentation.
* Includes installation and removal procedures.
* Has been tested through normal daily use.
* Is considered production ready.

Version 1.0 represents the beginning of long-term support, not the end of development.