Rules

Secret ingredients to quality software

Edit
Info

Do you make your site easy to maintain?

Last updated by Brady Stroud on 11 Feb 2021 12:21 pm (3 months ago) See History

If you have database driven pages on your website, you need a way of updating the data quickly and easily. Each page should have an 'Edit' link - only visible when the site is running internally or in administrator mode - that takes you directly to the page for editing the content on that page. The exception to this is if you are using open-source data. SSW.People is a good example of this.

Figure: "New" and "Edit" links allow SSW Employees to maintain testimonial entries easily

wordpress edit
Figure: "Edit" button on WordPress admin bar

github edit
Figure: Good Example - "Edit" button on an Open Source page

From Github, you can edit and submit a pull request. See https://github.com/SSWConsulting/SSW.People.Profiles/wiki (SSW People) or https://github.com/SSWConsulting/SSW.Rules.Content/wiki (SSW Rules) for more details.

This is better than sending a 'Change from X to Y' email (http://rules.ssw.com.au/do-you-ask-for-content-changes-using-from-x-to-y) as the work can be done immediately with less work and management requirements.

Related Rule

markdown
Do you use Markdown to store your content?

Adam CoganAdam Cogan

We open source. This page is on GitHub