Skip to content

Commit

Permalink
Merge pull request #24 from alps-asd/4beginner
Browse files Browse the repository at this point in the history
イントロダクションが難しく感じられる方へのページを追加
  • Loading branch information
koriym committed Feb 10, 2024
2 parents 3f96ed6 + 919710b commit f9235db
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 0 deletions.
2 changes: 2 additions & 0 deletions manuals/1.0/en/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,5 @@ Utilizing ASD increases project transparency and minimizes discrepancies between
ALPS and ASD are important tools for designing and understanding REST applications within the framework of information architecture. ALPS standardizes the meaning and structure of the data handled by the application and uses a common vocabulary to define the meaning and function of information. ASD, on the other hand, provides a state transition diagram of the application, helping to visually understand the user's actions and the application's reactions. Thus, ALPS and ASD provide a foundation for enhancing information architecture in REST application development, supporting efficient communication among teams, and improving consistency and quality throughout the project.

Building a **basis of shared understanding** that resolves conflicts among diverse developers is essential to increase development efficiency, provide a superior user experience, and ensure project sustainability. ALPS and ASD can be very effective tools to achieve this goal.

[If you find this text difficult, click here](index4b.html)
28 changes: 28 additions & 0 deletions manuals/1.0/en/indexb4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
layout: docs-en
title: Introduction
category: Manual
permalink: /manuals/1.0/en/index4b.html
---
# Introduction

![ASD](https://alps-asd.github.io/app-state-diagram/blog/profile.svg)

## ALPS: A way to organize app information

ALPS (Application Level Profile Semantics) is a way to neatly describe the information and mechanics of an app. It adds app-specific information to formats commonly used on the Internet (e.g., JSON and HTML) to clarify how the app works and what information it handles. This will make the process of creating the app smoother and allow different apps and systems to work well together.

For example, consider an online shopping site. For the sequence of steps (including payment) that a customer goes through to select and buy a product, ALPS can clearly show what is happening at each step. This makes it easier for those who create the app to make the necessary improvements to ensure a smooth shopping experience for customers.

## ASD: Diagrams showing how the app works

The ASD (Application State Transition Diagram) shows a diagram of how the app moves and the operations the user can perform based on the app information described in the ALPS. This allows you to understand at a glance how the app is working. In the case of an online shopping site, the diagram shows a series of steps, such as searching for a product, adding it to the cart, and paying for it.

ASD allows people in different roles in the team building the app, such as programmers and designers, to have a common understanding of how the app should work. This can be very helpful in discussions about how to improve the app and in coming up with new ideas.

## Designing REST Applications

ALPS and ASD are especially useful for designing apps that run on the web (called REST applications). Using these tools, you can clearly show what information the app handles and how it works. The result is an app that is easier to create and improve, and more user-friendly for the people using it.

In order for team members with diverse skills to work efficiently toward the same goal, it is important that they understand exactly what each other is working on, and ALPS and ASD are very useful tools to help them achieve this understanding.

2 changes: 2 additions & 0 deletions manuals/1.0/ja/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,5 @@ ASDを活用することで、プロジェクトの透明性が高まり、各
ALPSとASDは、情報アーキテクチャの枠組み内でRESTアプリケーションを設計し、理解する際に重要なツールです。ALPSはアプリケーションが扱うデータの意味や構造を標準化し、共通の語彙を使用して情報の意味と機能を定義します。一方、ASDはアプリケーションの状態遷移図を提供し、ユーザーのアクションとアプリケーションの反応を視覚的に理解するのを助けます。このように、ALPSとASDはRESTアプリケーション開発における情報アーキテクチャの強化と、チーム間の効率的なコミュニケーションを支援し、プロジェクト全体の一貫性と品質を向上させるための基盤を提供します。

開発効率を高め、優れたユーザーエクスペリエンスを提供し、プロジェクトの持続可能性を確保するためには、多様な開発者間の衝突を解決する**共有理解の基盤**を構築することが不可欠です。ALPSとASDは、このゴールを達成するために非常に効果的なツールとなります。

[この文章が難しく感じられる方はこちら](index4b.html)
27 changes: 27 additions & 0 deletions manuals/1.0/ja/index4b.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
layout: docs-ja
title: イントロダクション(for beginner)
category: Manual
permalink: /manuals/1.0/ja/index4b.html
---
# イントロダクション

![ASD](https://alps-asd.github.io/app-state-diagram/blog/profile.svg)

## ALPS:アプリの情報を整理する方法

ALPS(アプリケーションレベルのプロファイルセマンティクス)は、アプリの情報や仕組みをきちんと説明するための方法です。インターネット上でよく使われる形式(例えばJSONやHTML)に、アプリ固有の情報を加えて、そのアプリがどのように動くのか、どんな情報を扱っているのかをはっきりさせます。これにより、アプリを作る過程がスムーズになり、異なるアプリやシステム同士が上手く連携できるようになります。

例えば、ネットショッピングのサイトを考えてみましょう。お客さんが商品を選んで買うまでの一連の手順(支払いを含む)について、ALPSを使うと、それぞれのステップで何が起こっているのかを明確に示すことができます。これにより、アプリを作る人たちは、お客さんがスムーズに買い物ができるように、必要な改善をしやすくなります。

## ASD:アプリの動きを図で見る

ASD(アプリケーション状態遷移図)は、ALPSで説明されたアプリの情報をもとに、アプリの動きやユーザーができる操作を図で示します。これにより、アプリがどのように動いているのかを一目で理解できるようになります。ネットショッピングのサイトでいうと、商品を探してカートに入れる、支払う、という一連の流れが図で示されます。

ASDを使うと、アプリを作っているチームの中で、プログラマーやデザイナーなど、異なる役割の人たちが、アプリがどのように動くべきかについて、共通の理解を持つことができます。これは、アプリをより良くするための議論や、新しいアイデアを出し合う際にとても役立ちます。

## RESTアプリケーションの設計

ALPSとASDは、特にWeb上で動くアプリ(RESTアプリケーションと呼ばれます)の設計に役立ちます。これらのツールを使うことで、アプリがどのような情報を扱い、どのように動くのかをはっきりと示すことができます。結果として、アプリの作成や改善がしやすくなり、使っている人にとっても、より使いやすいアプリになります。

多様なスキルを持つチームメンバーが同じ目標に向かって効率的に作業を進めるためには、お互いの作業内容を正確に理解し合うことが大切です。ALPSとASDは、そのための理解を深めるのに非常に役立つツールです。

0 comments on commit f9235db

Please sign in to comment.